gtk-0.14.2: Binding to the Gtk+ graphical user interface library.

Maintainergtk2hs-users@lists.sourceforge.net
Stabilityprovisional
Portabilityportable (depends on GHC)
Safe HaskellNone
LanguageHaskell98

Graphics.UI.Gtk.Windows.AboutDialog

Contents

Description

Display information about an application

  • Module available since Gtk+ version 2.6

Synopsis

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 Source

Instances

class DialogClass o => AboutDialogClass o Source

Instances

castToAboutDialog :: GObjectClass obj => obj -> AboutDialog Source

gTypeAboutDialog :: GType Source

toAboutDialog :: AboutDialogClass o => o -> AboutDialog Source

Constructors

aboutDialogNew :: IO AboutDialog Source

Creates a new AboutDialog.

Methods

aboutDialogSetEmailHook Source

Arguments

:: GlibString string 
=> (string -> IO ())

(url -> ...) - a function to call when an email link is activated.

-> IO () 

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

Removed in Gtk3.

aboutDialogSetUrlHook Source

Arguments

:: GlibString string 
=> (string -> IO ())

(url -> ...) - a function to call when a URL link is activated.

-> IO () 

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

Removed in Gtk3.

Attributes

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

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

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

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

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

The version of the program.

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

Copyright information for the program.

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

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) Source

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 Source

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 Source

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] Source

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] Source

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] Source

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 Source

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) Source

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) Source

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 Source

Whether to wrap the text in the license dialog.

Default value: False

Deprecated

aboutDialogGetName Source

Arguments

:: (AboutDialogClass self, GlibString string) 
=> self 
-> IO string

returns The program name.

Returns the program name displayed in the about dialog.

aboutDialogSetName Source

Arguments

:: (AboutDialogClass self, GlibString string) 
=> self 
-> string

name - the program name

-> IO () 

Sets the name to display in the about dialog. If this is not set, it defaults to the program executable name.

aboutDialogGetVersion :: (AboutDialogClass self, GlibString string) => self -> IO string Source

Returns the version string.

aboutDialogSetVersion :: (AboutDialogClass self, GlibString string) => self -> string -> IO () Source

Sets the version string to display in the about dialog.

aboutDialogGetCopyright :: (AboutDialogClass self, GlibString string) => self -> IO string Source

Returns the copyright string.

aboutDialogSetCopyright :: (AboutDialogClass self, GlibString string) => self -> string -> IO () Source

Sets the copyright string to display in the about dialog. This should be a short string of one or two lines.

aboutDialogGetComments :: (AboutDialogClass self, GlibString string) => self -> IO string Source

Returns the comments string.

aboutDialogSetComments :: (AboutDialogClass self, GlibString string) => self -> string -> IO () Source

Sets the comments string to display in the about dialog. This should be a short string of one or two lines.

aboutDialogGetLicense :: (AboutDialogClass self, GlibString string) => self -> IO (Maybe string) Source

Returns the license information.

aboutDialogSetLicense Source

Arguments

:: (AboutDialogClass self, GlibString string) 
=> self 
-> Maybe string

license - the license information or Nothing

-> IO () 

Sets the license information to be displayed in the secondary license dialog. If license is Nothing, the license button is hidden.

aboutDialogGetWebsite :: (AboutDialogClass self, GlibString string) => self -> IO string Source

Returns the website URL.

aboutDialogSetWebsite Source

Arguments

:: (AboutDialogClass self, GlibString string) 
=> self 
-> string

website - a URL string starting with "http://"

-> IO () 

Sets the URL to use for the website link.

aboutDialogGetWebsiteLabel :: (AboutDialogClass self, GlibString string) => self -> IO string Source

Returns the label used for the website link.

aboutDialogSetWebsiteLabel :: (AboutDialogClass self, GlibString string) => self -> string -> IO () Source

Sets the label to be used for the website link. It defaults to the website URL.

aboutDialogSetAuthors Source

Arguments

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

authors - a list of author names

-> IO () 

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

aboutDialogGetAuthors :: (AboutDialogClass self, GlibString string) => self -> IO [string] Source

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

aboutDialogSetArtists Source

Arguments

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

artists - a list of artist names

-> IO () 

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

aboutDialogGetArtists :: (AboutDialogClass self, GlibString string) => self -> IO [string] Source

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

aboutDialogSetDocumenters Source

Arguments

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

artists - a list of documenter names

-> IO () 

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

aboutDialogGetDocumenters :: (AboutDialogClass self, GlibString string) => self -> IO [string] Source

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

aboutDialogGetTranslatorCredits :: (AboutDialogClass self, GlibString string) => self -> IO string Source

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

aboutDialogSetTranslatorCredits :: (AboutDialogClass self, GlibString string) => self -> string -> IO () Source

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.

aboutDialogGetLogo :: AboutDialogClass self => self -> IO Pixbuf Source

Returns the pixbuf displayed as logo in the about dialog.

aboutDialogSetLogo Source

Arguments

:: AboutDialogClass self 
=> self 
-> Maybe Pixbuf

logo - a Pixbuf, or Nothing

-> IO () 

Sets the pixbuf to be displayed as logo in the about dialog. If it is Nothing, the default window icon set with windowSetDefaultIcon will be used.

aboutDialogGetLogoIconName :: (AboutDialogClass self, GlibString string) => self -> IO string Source

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

aboutDialogSetLogoIconName Source

Arguments

:: (AboutDialogClass self, GlibString string) 
=> self 
-> Maybe string

iconName - an icon name, or Nothing

-> IO () 

Sets the pixbuf to be displayed as logo in the about dialog. If it is Nothing, the default window icon set with windowSetDefaultIcon will be used.

aboutDialogGetWrapLicense Source

Arguments

:: AboutDialogClass self 
=> self 
-> IO Bool

returns True if the license text is wrapped

Returns whether the license text in about is automatically wrapped.

  • Available since Gtk+ version 2.8

aboutDialogSetWrapLicense Source

Arguments

:: AboutDialogClass self 
=> self 
-> Bool

wrapLicense - whether to wrap the license

-> IO () 

Sets whether the license text in about is automatically wrapped.

  • Available since Gtk+ version 2.8