gi-gtk-3.0.11: Gtk bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.AboutDialog

Contents

Description

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 showUri 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 <edgar@poe.com>". 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.

Synopsis

Exported types

Methods

addCreditSection

aboutDialogAddCreditSection Source #

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

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

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

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

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

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

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

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

Source #

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

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

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

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

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

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

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

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

Arguments

:: (HasCallStack, MonadIO m) 
=> m AboutDialog

Returns: a newly created AboutDialog

Creates a new AboutDialog.

Since: 2.6

setArtists

aboutDialogSetArtists Source #

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

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

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

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

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

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

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

Source #

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

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

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

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

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

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

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

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

data AboutDialogArtistsPropertyInfo Source #

Instances

AttrInfo AboutDialogArtistsPropertyInfo Source # 
type AttrOrigin AboutDialogArtistsPropertyInfo Source # 
type AttrLabel AboutDialogArtistsPropertyInfo Source # 
type AttrGetType AboutDialogArtistsPropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogArtistsPropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogArtistsPropertyInfo Source # 
type AttrAllowedOps AboutDialogArtistsPropertyInfo Source # 

authors

data AboutDialogAuthorsPropertyInfo Source #

Instances

AttrInfo AboutDialogAuthorsPropertyInfo Source # 
type AttrOrigin AboutDialogAuthorsPropertyInfo Source # 
type AttrLabel AboutDialogAuthorsPropertyInfo Source # 
type AttrGetType AboutDialogAuthorsPropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogAuthorsPropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogAuthorsPropertyInfo Source # 
type AttrAllowedOps AboutDialogAuthorsPropertyInfo Source # 

comments

data AboutDialogCommentsPropertyInfo Source #

Instances

AttrInfo AboutDialogCommentsPropertyInfo Source # 
type AttrOrigin AboutDialogCommentsPropertyInfo Source # 
type AttrLabel AboutDialogCommentsPropertyInfo Source # 
type AttrGetType AboutDialogCommentsPropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogCommentsPropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogCommentsPropertyInfo Source # 
type AttrAllowedOps AboutDialogCommentsPropertyInfo Source # 

copyright

data AboutDialogCopyrightPropertyInfo Source #

Instances

AttrInfo AboutDialogCopyrightPropertyInfo Source # 
type AttrOrigin AboutDialogCopyrightPropertyInfo Source # 
type AttrLabel AboutDialogCopyrightPropertyInfo Source # 
type AttrGetType AboutDialogCopyrightPropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogCopyrightPropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogCopyrightPropertyInfo Source # 
type AttrAllowedOps AboutDialogCopyrightPropertyInfo Source # 

documenters

data AboutDialogDocumentersPropertyInfo Source #

Instances

AttrInfo AboutDialogDocumentersPropertyInfo Source # 
type AttrOrigin AboutDialogDocumentersPropertyInfo Source # 
type AttrLabel AboutDialogDocumentersPropertyInfo Source # 
type AttrGetType AboutDialogDocumentersPropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogDocumentersPropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogDocumentersPropertyInfo Source # 
type AttrAllowedOps AboutDialogDocumentersPropertyInfo Source # 

license

data AboutDialogLicensePropertyInfo Source #

Instances

AttrInfo AboutDialogLicensePropertyInfo Source # 
type AttrOrigin AboutDialogLicensePropertyInfo Source # 
type AttrLabel AboutDialogLicensePropertyInfo Source # 
type AttrGetType AboutDialogLicensePropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogLicensePropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogLicensePropertyInfo Source # 
type AttrAllowedOps AboutDialogLicensePropertyInfo Source # 

licenseType

data AboutDialogLicenseTypePropertyInfo Source #

Instances

AttrInfo AboutDialogLicenseTypePropertyInfo Source # 
type AttrOrigin AboutDialogLicenseTypePropertyInfo Source # 
type AttrLabel AboutDialogLicenseTypePropertyInfo Source # 
type AttrGetType AboutDialogLicenseTypePropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogLicenseTypePropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogLicenseTypePropertyInfo Source # 
type AttrAllowedOps AboutDialogLicenseTypePropertyInfo Source # 

logo

data AboutDialogLogoPropertyInfo Source #

Instances

AttrInfo AboutDialogLogoPropertyInfo Source # 
type AttrOrigin AboutDialogLogoPropertyInfo Source # 
type AttrLabel AboutDialogLogoPropertyInfo Source # 
type AttrGetType AboutDialogLogoPropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogLogoPropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogLogoPropertyInfo Source # 
type AttrAllowedOps AboutDialogLogoPropertyInfo Source # 

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

logoIconName

data AboutDialogLogoIconNamePropertyInfo Source #

Instances

AttrInfo AboutDialogLogoIconNamePropertyInfo Source # 
type AttrOrigin AboutDialogLogoIconNamePropertyInfo Source # 
type AttrLabel AboutDialogLogoIconNamePropertyInfo Source # 
type AttrGetType AboutDialogLogoIconNamePropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogLogoIconNamePropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogLogoIconNamePropertyInfo Source # 
type AttrAllowedOps AboutDialogLogoIconNamePropertyInfo Source # 

programName

data AboutDialogProgramNamePropertyInfo Source #

Instances

AttrInfo AboutDialogProgramNamePropertyInfo Source # 
type AttrOrigin AboutDialogProgramNamePropertyInfo Source # 
type AttrLabel AboutDialogProgramNamePropertyInfo Source # 
type AttrGetType AboutDialogProgramNamePropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogProgramNamePropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogProgramNamePropertyInfo Source # 
type AttrAllowedOps AboutDialogProgramNamePropertyInfo Source # 

translatorCredits

data AboutDialogTranslatorCreditsPropertyInfo Source #

Instances

AttrInfo AboutDialogTranslatorCreditsPropertyInfo Source # 
type AttrOrigin AboutDialogTranslatorCreditsPropertyInfo Source # 
type AttrLabel AboutDialogTranslatorCreditsPropertyInfo Source # 
type AttrGetType AboutDialogTranslatorCreditsPropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogTranslatorCreditsPropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogTranslatorCreditsPropertyInfo Source # 
type AttrAllowedOps AboutDialogTranslatorCreditsPropertyInfo Source # 

version

data AboutDialogVersionPropertyInfo Source #

Instances

AttrInfo AboutDialogVersionPropertyInfo Source # 
type AttrOrigin AboutDialogVersionPropertyInfo Source # 
type AttrLabel AboutDialogVersionPropertyInfo Source # 
type AttrGetType AboutDialogVersionPropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogVersionPropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogVersionPropertyInfo Source # 
type AttrAllowedOps AboutDialogVersionPropertyInfo Source # 

website

data AboutDialogWebsitePropertyInfo Source #

Instances

AttrInfo AboutDialogWebsitePropertyInfo Source # 
type AttrOrigin AboutDialogWebsitePropertyInfo Source # 
type AttrLabel AboutDialogWebsitePropertyInfo Source # 
type AttrGetType AboutDialogWebsitePropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogWebsitePropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogWebsitePropertyInfo Source # 
type AttrAllowedOps AboutDialogWebsitePropertyInfo Source # 

websiteLabel

data AboutDialogWebsiteLabelPropertyInfo Source #

Instances

AttrInfo AboutDialogWebsiteLabelPropertyInfo Source # 
type AttrOrigin AboutDialogWebsiteLabelPropertyInfo Source # 
type AttrLabel AboutDialogWebsiteLabelPropertyInfo Source # 
type AttrGetType AboutDialogWebsiteLabelPropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogWebsiteLabelPropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogWebsiteLabelPropertyInfo Source # 
type AttrAllowedOps AboutDialogWebsiteLabelPropertyInfo Source # 

wrapLicense

data AboutDialogWrapLicensePropertyInfo Source #

Instances

AttrInfo AboutDialogWrapLicensePropertyInfo Source # 
type AttrOrigin AboutDialogWrapLicensePropertyInfo Source # 
type AttrLabel AboutDialogWrapLicensePropertyInfo Source # 
type AttrGetType AboutDialogWrapLicensePropertyInfo Source # 
type AttrBaseTypeConstraint AboutDialogWrapLicensePropertyInfo Source # 
type AttrSetTypeConstraint AboutDialogWrapLicensePropertyInfo Source # 
type AttrAllowedOps AboutDialogWrapLicensePropertyInfo Source # 

Signals

activateLink