GI.Gtk.Objects.AboutDialog

The GtkAboutDialog 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 dialogs often contain links and email addresses. GtkAboutDialog displays these as clickable links. By default, it calls showUriOnWindow when a user clicks one. The behaviour can be overridden with the AboutDialog::activate-link signal.

To specify a person with an email address, use a string like "Edgar Allan Poe <[e-mail]>". To specify a website with a title, use a string like "GTK+ team http://www.gtk.org".

To make constructing a GtkAboutDialog as convenient as possible, you can use the function gtk_show_about_dialog() which constructs and shows a dialog and keeps it around so that it can be shown again.

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 GtkAboutDialog, as shown in the following example:

C code

gtk_show_about_dialog (NULL,
                       "program-name", "ExampleCode",
                       "logo", example_logo,
                       "title" _("About ExampleCode"),
                       NULL);

It is also possible to show a AboutDialog like any other Dialog, e.g. using dialogRun. In this case, you might need to know that the “Close” button returns the GTK_RESPONSE_CANCEL response id.

Exported types

newtype AboutDialog

Constructors

AboutDialog (ManagedPtr AboutDialog)

Instances

GObject AboutDialog

Methods

gobjectType :: AboutDialog -> IO GType

IsImplementorIface AboutDialog

IsObject AboutDialog

IsWindow AboutDialog

IsWidget AboutDialog

IsDialog AboutDialog

IsContainer AboutDialog

IsBin AboutDialog

IsBuildable AboutDialog

IsAboutDialog AboutDialog

class GObject o => IsAboutDialog o

Instances

(GObject a, UnknownAncestorError Constraint AboutDialog a) => IsAboutDialog a

IsAboutDialog AboutDialog

toAboutDialog :: (MonadIO m, IsAboutDialog o) => o -> m AboutDialog

noAboutDialog :: Maybe AboutDialog

Methods

addCreditSection

aboutDialogAddCreditSection

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: A AboutDialog

-> Text

sectionName: The name of the section

-> [Text]

people: The people who belong to that section

-> m ()

Creates a new section in the Credits page.

Since: 3.4

getArtists

aboutDialogGetArtists

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m [Text]

Returns: A Nothing-terminated string array containing the artists. The array is owned by the about dialog and must not be modified.

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

Since: 2.6

getAuthors

aboutDialogGetAuthors

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m [Text]

Returns: A Nothing-terminated string array containing the authors. The array is owned by the about dialog and must not be modified.

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

Since: 2.6

getComments

aboutDialogGetComments

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m Text

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

Returns the comments string.

Since: 2.6

getCopyright

aboutDialogGetCopyright

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m Text

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

Returns the copyright string.

Since: 2.6

getDocumenters

aboutDialogGetDocumenters

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m [Text]

Returns: A Nothing-terminated string array containing the documenters. The array is owned by the about dialog and must not be modified.

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

Since: 2.6

getLicense

aboutDialogGetLicense

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m Text

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

Returns the license information.

Since: 2.6

getLicenseType

aboutDialogGetLicenseType

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m License

Returns: a License value

Retrieves the license set using aboutDialogSetLicenseType

Since: 3.0

getLogo

aboutDialogGetLogo

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m Pixbuf

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 objectRef on it.

Returns the pixbuf displayed as logo in the about dialog.

Since: 2.6

getLogoIconName

aboutDialogGetLogoIconName

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m Text

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 strdup on it.

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

Since: 2.6

getProgramName

aboutDialogGetProgramName

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m Text

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

Returns the program name displayed in the about dialog.

Since: 2.12

getTranslatorCredits

aboutDialogGetTranslatorCredits

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m Text

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

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

Since: 2.6

getVersion

aboutDialogGetVersion

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m Text

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

Returns the version string.

Since: 2.6

getWebsite

aboutDialogGetWebsite

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m Text

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

Returns the website URL.

Since: 2.6

getWebsiteLabel

aboutDialogGetWebsiteLabel

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m Text

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

Returns the label used for the website link.

Since: 2.6

getWrapLicense

aboutDialogGetWrapLicense

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> m Bool

Returns: True if the license text is wrapped

Returns whether the license text in about is automatically wrapped.

Since: 2.8

new

aboutDialogNew

Arguments

:: (HasCallStack, MonadIO m)

=> m AboutDialog

Returns: a newly created AboutDialog

Creates a new AboutDialog.

Since: 2.6

setArtists

aboutDialogSetArtists

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> [Text]

artists: a Nothing-terminated array of strings

-> m ()

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

Since: 2.6

setAuthors

aboutDialogSetAuthors

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> [Text]

authors: a Nothing-terminated array of strings

-> m ()

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

Since: 2.6

setComments

aboutDialogSetComments

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> Maybe Text

comments: a comments string

-> m ()

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

Since: 2.6

setCopyright

aboutDialogSetCopyright

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> Maybe Text

copyright: the copyright string

-> m ()

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

Since: 2.6

setDocumenters

aboutDialogSetDocumenters

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> [Text]

documenters: a Nothing-terminated array of strings

-> m ()

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

Since: 2.6

setLicense

aboutDialogSetLicense

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> Maybe Text

license: the license information or Nothing

-> m ()

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

Since: 2.6

setLicenseType

aboutDialogSetLicenseType

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> License

licenseType: the type of license

-> m ()

Sets the license of the application showing the about dialog from a list of known licenses.

This function overrides the license set using aboutDialogSetLicense.

Since: 3.0

setLogo

aboutDialogSetLogo

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a, IsPixbuf b)

=> a

about: a AboutDialog

-> Maybe b

logo: a Pixbuf, or Nothing

-> m ()

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.

Since: 2.6

setLogoIconName

aboutDialogSetLogoIconName

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> Maybe Text

iconName: an icon name, or Nothing

-> m ()

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.

Since: 2.6

setProgramName

aboutDialogSetProgramName

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> Text

name: the program name

-> m ()

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

Since: 2.12

setTranslatorCredits

aboutDialogSetTranslatorCredits

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> Maybe Text

translatorCredits: the translator credits

-> m ()

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:

C code

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 AboutDialog will detect if “translator-credits” is untranslated and hide the tab.

Since: 2.6

setVersion

aboutDialogSetVersion

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> Maybe Text

version: the version string

-> m ()

Sets the version string to display in the about dialog.

Since: 2.6

setWebsite

aboutDialogSetWebsite

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> Maybe Text

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

-> m ()

Sets the URL to use for the website link.

Since: 2.6

setWebsiteLabel

aboutDialogSetWebsiteLabel

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> Text

websiteLabel: the label used for the website link

-> m ()

Sets the label to be used for the website link.

Since: 2.6

setWrapLicense

aboutDialogSetWrapLicense

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a AboutDialog

-> Bool

wrapLicense: whether to wrap the license

-> m ()

Sets whether the license text in about is automatically wrapped.

Since: 2.8

Properties

artists

constructAboutDialogArtists :: IsAboutDialog o => [Text] -> IO (GValueConstruct o)

getAboutDialogArtists :: (MonadIO m, IsAboutDialog o) => o -> m [Text]

setAboutDialogArtists :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m ()

authors

constructAboutDialogAuthors :: IsAboutDialog o => [Text] -> IO (GValueConstruct o)

getAboutDialogAuthors :: (MonadIO m, IsAboutDialog o) => o -> m [Text]

setAboutDialogAuthors :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m ()

comments

clearAboutDialogComments :: (MonadIO m, IsAboutDialog o) => o -> m ()

constructAboutDialogComments :: IsAboutDialog o => Text -> IO (GValueConstruct o)

getAboutDialogComments :: (MonadIO m, IsAboutDialog o) => o -> m Text

setAboutDialogComments :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()

copyright

clearAboutDialogCopyright :: (MonadIO m, IsAboutDialog o) => o -> m ()

constructAboutDialogCopyright :: IsAboutDialog o => Text -> IO (GValueConstruct o)

getAboutDialogCopyright :: (MonadIO m, IsAboutDialog o) => o -> m Text

setAboutDialogCopyright :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()

documenters

constructAboutDialogDocumenters :: IsAboutDialog o => [Text] -> IO (GValueConstruct o)

getAboutDialogDocumenters :: (MonadIO m, IsAboutDialog o) => o -> m [Text]

setAboutDialogDocumenters :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m ()

license

clearAboutDialogLicense :: (MonadIO m, IsAboutDialog o) => o -> m ()

constructAboutDialogLicense :: IsAboutDialog o => Text -> IO (GValueConstruct o)

getAboutDialogLicense :: (MonadIO m, IsAboutDialog o) => o -> m Text

setAboutDialogLicense :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()

licenseType

constructAboutDialogLicenseType :: IsAboutDialog o => License -> IO (GValueConstruct o)

getAboutDialogLicenseType :: (MonadIO m, IsAboutDialog o) => o -> m License

setAboutDialogLicenseType :: (MonadIO m, IsAboutDialog o) => o -> License -> m ()

logo

clearAboutDialogLogo :: (MonadIO m, IsAboutDialog o) => o -> m ()

constructAboutDialogLogo :: (IsAboutDialog o, IsPixbuf a) => a -> IO (GValueConstruct o)

getAboutDialogLogo :: (MonadIO m, IsAboutDialog o) => o -> m Pixbuf

setAboutDialogLogo :: (MonadIO m, IsAboutDialog o, IsPixbuf a) => o -> a -> m ()

logoIconName

clearAboutDialogLogoIconName :: (MonadIO m, IsAboutDialog o) => o -> m ()

constructAboutDialogLogoIconName :: IsAboutDialog o => Text -> IO (GValueConstruct o)

getAboutDialogLogoIconName :: (MonadIO m, IsAboutDialog o) => o -> m Text

setAboutDialogLogoIconName :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()

programName

constructAboutDialogProgramName :: IsAboutDialog o => Text -> IO (GValueConstruct o)

getAboutDialogProgramName :: (MonadIO m, IsAboutDialog o) => o -> m Text

setAboutDialogProgramName :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()

translatorCredits

clearAboutDialogTranslatorCredits :: (MonadIO m, IsAboutDialog o) => o -> m ()

constructAboutDialogTranslatorCredits :: IsAboutDialog o => Text -> IO (GValueConstruct o)

getAboutDialogTranslatorCredits :: (MonadIO m, IsAboutDialog o) => o -> m Text

setAboutDialogTranslatorCredits :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()

version

clearAboutDialogVersion :: (MonadIO m, IsAboutDialog o) => o -> m ()

constructAboutDialogVersion :: IsAboutDialog o => Text -> IO (GValueConstruct o)

getAboutDialogVersion :: (MonadIO m, IsAboutDialog o) => o -> m Text

setAboutDialogVersion :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()

website

clearAboutDialogWebsite :: (MonadIO m, IsAboutDialog o) => o -> m ()

constructAboutDialogWebsite :: IsAboutDialog o => Text -> IO (GValueConstruct o)

getAboutDialogWebsite :: (MonadIO m, IsAboutDialog o) => o -> m Text

setAboutDialogWebsite :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()

websiteLabel

constructAboutDialogWebsiteLabel :: IsAboutDialog o => Text -> IO (GValueConstruct o)

getAboutDialogWebsiteLabel :: (MonadIO m, IsAboutDialog o) => o -> m Text

setAboutDialogWebsiteLabel :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()

wrapLicense

constructAboutDialogWrapLicense :: IsAboutDialog o => Bool -> IO (GValueConstruct o)

getAboutDialogWrapLicense :: (MonadIO m, IsAboutDialog o) => o -> m Bool

setAboutDialogWrapLicense :: (MonadIO m, IsAboutDialog o) => o -> Bool -> m ()

Signals

activateLink

type AboutDialogActivateLinkCallback = Text -> IO Bool

type C_AboutDialogActivateLinkCallback = Ptr () -> CString -> Ptr () -> IO CInt

afterAboutDialogActivateLink :: (IsAboutDialog a, MonadIO m) => a -> AboutDialogActivateLinkCallback -> m SignalHandlerId

genClosure_AboutDialogActivateLink :: AboutDialogActivateLinkCallback -> IO Closure

mk_AboutDialogActivateLinkCallback :: C_AboutDialogActivateLinkCallback -> IO (FunPtr C_AboutDialogActivateLinkCallback)

noAboutDialogActivateLinkCallback :: Maybe AboutDialogActivateLinkCallback

onAboutDialogActivateLink :: (IsAboutDialog a, MonadIO m) => a -> AboutDialogActivateLinkCallback -> m SignalHandlerId

wrap_AboutDialogActivateLinkCallback :: AboutDialogActivateLinkCallback -> Ptr () -> CString -> Ptr () -> IO CInt