Graphics.UI.Gtk.Windows.AboutDialog

Display information about an application

• Module available since Gtk+ version 2.6

Detail

The 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.

About dialog often contain links and email addresses. AboutDialog supports this by offering global hooks, which are called when the user clicks on a link or email address, see aboutDialogSetEmailHook and aboutDialogSetUrlHook. Email addresses in the authors, documenters and artists properties are recognized by looking for <user@host>, URLs are recognized by looking for http://url, with url extending to the next space, tab or line break. Since 2.18 AboutDialog provides default website and email hooks that use showURI.

Note that Gtk+ sets a default title of _("About %s") on the dialog window (where %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 AboutDialog, as shown in the following example:

Note that prior to Gtk+ 2.12, the aboutDialogProgramName property was called aboutDialogName. Both names may be used in Gtk2Hs.

Class Hierarchy

| GObject
| +----Object
| +----Widget
| +----Container
| +----Bin
| +----Window
| +----Dialog
| +----AboutDialog

Types

data AboutDialog

Instances

Eq AboutDialog

Ord AboutDialog

GObjectClass AboutDialog

AboutDialogClass AboutDialog

DialogClass AboutDialog

WindowClass AboutDialog

BinClass AboutDialog

ContainerClass AboutDialog

WidgetClass AboutDialog

class DialogClass o => AboutDialogClass o

Instances

AboutDialogClass AboutDialog

castToAboutDialog :: GObjectClass obj => obj -> AboutDialog

gTypeAboutDialog :: GType

toAboutDialog :: AboutDialogClass o => o -> AboutDialog

Constructors

aboutDialogNew :: IO AboutDialog

Creates a new AboutDialog.

Methods

Attributes

aboutDialogProgramName :: (AboutDialogClass self, GlibString string) => Attr self string

The name of the program. If this is not set, it defaults to gGetApplicationName.

aboutDialogName :: (AboutDialogClass self, GlibString string) => Attr self string

The name of the program. If this is not set, it defaults to gGetApplicationName.

aboutDialogVersion :: (AboutDialogClass self, GlibString string) => Attr self string

The version of the program.

aboutDialogCopyright :: (AboutDialogClass self, GlibString string) => Attr self string

Copyright information for the program.

aboutDialogComments :: (AboutDialogClass self, GlibString string) => Attr self string

Comments about the program. This string is displayed in a label in the main dialog, thus it should be a short explanation of the main purpose of the program, not a detailed list of features.

aboutDialogLicense :: (AboutDialogClass self, GlibString string) => Attr self (Maybe string)

The license of the program. This string is displayed in a text view in a secondary dialog, therefore it is fine to use a long multi-paragraph text. Note that the text is only wrapped in the text view if the aboutDialogWrapLicense property is set to True; otherwise the text itself must contain the intended linebreaks.

Default value: Nothing

aboutDialogWebsite :: (AboutDialogClass self, GlibString string) => Attr self string

The URL for the link to the website of the program. This should be a string starting with "http://.

aboutDialogWebsiteLabel :: (AboutDialogClass self, GlibString string) => Attr self string

The label for the link to the website of the program. If this is not set, it defaults to the URL specified in the website property.

aboutDialogAuthors :: (AboutDialogClass self, GlibString string) => Attr self [string]

The authors of the program. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

aboutDialogDocumenters :: (AboutDialogClass self, GlibString string) => Attr self [string]

The people documenting the program. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

aboutDialogArtists :: (AboutDialogClass self, GlibString string) => Attr self [string]

The people who contributed artwork to the program. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

aboutDialogTranslatorCredits :: (AboutDialogClass self, GlibString string) => Attr self string

Credits to the translators. This string should be marked as translatable. The string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

aboutDialogLogo :: AboutDialogClass self => ReadWriteAttr self Pixbuf (Maybe Pixbuf)

A logo for the about box. If this is not set, it defaults to windowGetDefaultIconList.

aboutDialogLogoIconName :: (AboutDialogClass self, GlibString string) => ReadWriteAttr self string (Maybe string)

A named icon to use as the logo for the about box. This property overrides the logo property.

Default value: Nothing

aboutDialogWrapLicense :: AboutDialogClass self => Attr self Bool

Whether to wrap the text in the license dialog.

Default value: False

Deprecated