org.gnu.gtk

Class AboutDialog

public class AboutDialog extends Dialog

Display information about an application.

Gtk's AboutDialog 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 About option from the Help menu. All parts of the dialog are optional.

Constructor Summary
AboutDialog(Handle handle)
Internal constructor.
AboutDialog()
Create a new AboutDialog.
Method Summary
static AboutDialoggetAboutDialog(Handle handle)
Internal static factory method to be used by Java-Gnome only.
String[]getArtists()
Gets the strings which are displayed in the documenters tab of the secondary credits dialog.
String[]getAuthors()
Gets the strings which are displayed in the authors tab of the secondary credits dialog.
StringgetComments()
Gets the comments string displayed in the about dialog.
StringgetCopyright()
Gets the copyright string displayed in the about dialog.
String[]getDocumenters()
Gets the strings which are displayed in the artists tab of the secondary credits dialog.
StringgetLicense()
Gets the license information displayed in the secondary license dialog.
PixbufgetLogo()
Gets the pixbuf displayed as logo in the about dialog.
StringgetLogoIconName()
Gets the icon name displayed as logo in the about dialog.
StringgetName()
Gets the name displayed in the about dialog.
StringgetTranslatorCredits()
Gets the translator credits string which is displayed in the translators tab of the secondary credits dialog.
StringgetVersion()
Gets the version string displayed in the about dialog.
StringgetWebsite()
Gets the URL used for the website link.
StringgetWebsiteLabel()
Sets the label to be used for the website link.
booleangetWrapLicense()
Gets whether the license text will be automatically wrapped.
voidsetArtists(String[] val)
Sets the strings which are displayed in the documenters tab of the secondary credits dialog.
String[]setArtists()
Gets the strings which are displayed in the documenters tab of the secondary credits dialog.
voidsetAuthors(String[] val)
Sets the strings which are displayed in the authors tab of the secondary credits dialog.
voidsetComments(String val)
Sets the comments string to display in the about dialog.
voidsetCopyright(String val)
Sets the copyright string to display in the about dialog.
voidsetDocumenters(String[] val)
Sets the strings which are displayed in the artists tab of the secondary credits dialog.
String[]setDocumenters()
Gets the strings which are displayed in the artists tab of the secondary credits dialog.
static voidsetEmailHook(AboutDialogActivateLinkMethod method)
Set a handler object to be used whenever the user activates an Email link in the authors, documenters or artists sections.
voidsetLicense(String val)
Sets the license information to be displayed in the secondary license dialog.
voidsetLogo(Pixbuf val)
Sets the pixbuf to be displayed as logo in the about dialog.
voidsetLogoIconName(String val)
Sets the icon name displayed as logo in the about dialog.
voidsetName(String val)
Sets the name to display in the about dialog.
voidsetTranslatorCredits(String val)
Sets the translator credits string which is displayed in the translators tab of the secondary credits dialog.
static voidsetURLHook(AboutDialogActivateLinkMethod method)
Set a handler object to be used whenever the user activates a URL link in the authors, documenters or artists sections.
voidsetVersion(String val)
Sets the version string to display in the about dialog.
voidsetWebsite(String website)
Sets the URL to use for the website link.
StringsetWebsite()
Gets the URL used for the website link.
voidsetWebsiteLabel(String val)
Sets the label to be used for the website link.
voidsetWrapLicense(boolean wrapLicense)
Sets whether the license text is automatically wrapped.

Constructor Detail

AboutDialog

public AboutDialog(Handle handle)
Internal constructor.

AboutDialog

public AboutDialog()
Create a new AboutDialog.

Method Detail

getAboutDialog

public static AboutDialog getAboutDialog(Handle handle)
Internal static factory method to be used by Java-Gnome only.

getArtists

public String[] getArtists()
Gets the strings which are displayed in the documenters tab of the secondary credits dialog.

getAuthors

public String[] getAuthors()
Gets the strings which are displayed in the authors tab of the secondary credits dialog.

getComments

public String getComments()
Gets the comments string displayed in the about dialog.

getCopyright

public String getCopyright()
Gets the copyright string displayed in the about dialog.

getDocumenters

public String[] getDocumenters()
Gets the strings which are displayed in the artists tab of the secondary credits dialog.

getLicense

public String getLicense()
Gets the license information displayed in the secondary license dialog.

getLogo

public Pixbuf getLogo()
Gets the pixbuf displayed as logo in the about dialog.

getLogoIconName

public String getLogoIconName()
Gets the icon name displayed as logo in the about dialog.

getName

public String getName()
Gets the name displayed in the about dialog.

getTranslatorCredits

public String getTranslatorCredits()
Gets the translator credits string which is displayed in the translators tab of the secondary credits dialog.

getVersion

public String getVersion()
Gets the version string displayed in the about dialog.

getWebsite

public String getWebsite()
Gets the URL used for the website link.

getWebsiteLabel

public String getWebsiteLabel()
Sets the label to be used for the website link. It defaults to the website URL.

getWrapLicense

public boolean getWrapLicense()
Gets whether the license text will be automatically wrapped.

Returns: true if the license text will be wrapped automatically

setArtists

public void setArtists(String[] val)
Sets the strings which are displayed in the documenters tab of the secondary credits dialog.

setArtists

public String[] setArtists()

Deprecated: Use getArtists instead.

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

setAuthors

public void setAuthors(String[] val)
Sets the strings which are displayed in the authors tab of the secondary credits dialog.

setComments

public void setComments(String val)
Sets the comments string to display in the about dialog. This should be a short string of one or two lines.

setCopyright

public void setCopyright(String val)
Sets the copyright string to display in the about dialog. This should be a short string of one or two lines.

setDocumenters

public void setDocumenters(String[] val)
Sets the strings which are displayed in the artists tab of the secondary credits dialog.

setDocumenters

public String[] setDocumenters()

Deprecated: Use getDocumenters instead.

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

setEmailHook

public static void setEmailHook(AboutDialogActivateLinkMethod method)
Set a handler object to be used whenever the user activates an Email link in the authors, documenters or artists sections.

setLicense

public void setLicense(String val)
Sets the license information to be displayed in the secondary license dialog. If license is null, the license button is hidden.

Parameters: val The license information or NULL.

setLogo

public void setLogo(Pixbuf val)
Sets the pixbuf to be displayed as logo in the about dialog. If it is null, the default window icon set with Window will be used.

setLogoIconName

public void setLogoIconName(String val)
Sets the icon name displayed as logo in the about dialog.

setName

public void setName(String val)
Sets the name to display in the about dialog.

setTranslatorCredits

public void setTranslatorCredits(String val)
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. 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 AboutDialog will detect if "translator-credits" is untranslated and hide the tab.

setURLHook

public static void setURLHook(AboutDialogActivateLinkMethod method)
Set a handler object to be used whenever the user activates a URL link in the authors, documenters or artists sections.

setVersion

public void setVersion(String val)
Sets the version string to display in the about dialog.

setWebsite

public void setWebsite(String website)
Sets the URL to use for the website link.

Parameters: website A URL string starting with "http://".

setWebsite

public String setWebsite()

Deprecated: Use getWebsite.

Gets the URL used for the website link.

setWebsiteLabel

public void setWebsiteLabel(String val)
Sets the label to be used for the website link. It defaults to the website URL.

setWrapLicense

public void setWrapLicense(boolean wrapLicense)
Sets whether the license text is automatically wrapped.

Parameters: wrapLicense