Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Gtk.Objects.AboutDialog

Contents

Exported types
Methods
Properties
Signals
- activateLink

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 showUriOnWindow when a user clicks one. The behaviour can be overridden with the activateLink 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

GdkPixbuf *example_logo = gdk_pixbuf_new_from_file ("./logo.png", NULL);
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

newtype AboutDialog = AboutDialog (ManagedPtr AboutDialog)
class (GObject o, IsDescendantOf AboutDialog o) => IsAboutDialog o
toAboutDialog :: (MonadIO m, IsAboutDialog o) => o -> m AboutDialog
aboutDialogAddCreditSection :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> [Text] -> m ()
aboutDialogGetArtists :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m [Text]
aboutDialogGetAuthors :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m [Text]
aboutDialogGetComments :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetCopyright :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetDocumenters :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m [Text]
aboutDialogGetLicense :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetLicenseType :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m License
aboutDialogGetLogo :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Pixbuf
aboutDialogGetLogoIconName :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetProgramName :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetTranslatorCredits :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetVersion :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetWebsite :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetWebsiteLabel :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetWrapLicense :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Bool
aboutDialogNew :: (HasCallStack, MonadIO m) => m AboutDialog
aboutDialogSetArtists :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> [Text] -> m ()
aboutDialogSetAuthors :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> [Text] -> m ()
aboutDialogSetComments :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> m ()
aboutDialogSetCopyright :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> m ()
aboutDialogSetDocumenters :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> [Text] -> m ()
aboutDialogSetLicense :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> m ()
aboutDialogSetLicenseType :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> License -> m ()
aboutDialogSetLogo :: (HasCallStack, MonadIO m, IsAboutDialog a, IsPixbuf b) => a -> Maybe b -> m ()
aboutDialogSetLogoIconName :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> m ()
aboutDialogSetProgramName :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetTranslatorCredits :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> m ()
aboutDialogSetVersion :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> m ()
aboutDialogSetWebsite :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> m ()
aboutDialogSetWebsiteLabel :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetWrapLicense :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Bool -> m ()
constructAboutDialogArtists :: (IsAboutDialog o, MonadIO m) => [Text] -> m (GValueConstruct o)
getAboutDialogArtists :: (MonadIO m, IsAboutDialog o) => o -> m [Text]
setAboutDialogArtists :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m ()
constructAboutDialogAuthors :: (IsAboutDialog o, MonadIO m) => [Text] -> m (GValueConstruct o)
getAboutDialogAuthors :: (MonadIO m, IsAboutDialog o) => o -> m [Text]
setAboutDialogAuthors :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m ()
clearAboutDialogComments :: (MonadIO m, IsAboutDialog o) => o -> m ()
constructAboutDialogComments :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogComments :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogComments :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
clearAboutDialogCopyright :: (MonadIO m, IsAboutDialog o) => o -> m ()
constructAboutDialogCopyright :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogCopyright :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogCopyright :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
constructAboutDialogDocumenters :: (IsAboutDialog o, MonadIO m) => [Text] -> m (GValueConstruct o)
getAboutDialogDocumenters :: (MonadIO m, IsAboutDialog o) => o -> m [Text]
setAboutDialogDocumenters :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m ()
clearAboutDialogLicense :: (MonadIO m, IsAboutDialog o) => o -> m ()
constructAboutDialogLicense :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogLicense :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogLicense :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
constructAboutDialogLicenseType :: (IsAboutDialog o, MonadIO m) => License -> m (GValueConstruct o)
getAboutDialogLicenseType :: (MonadIO m, IsAboutDialog o) => o -> m License
setAboutDialogLicenseType :: (MonadIO m, IsAboutDialog o) => o -> License -> m ()
clearAboutDialogLogo :: (MonadIO m, IsAboutDialog o) => o -> m ()
constructAboutDialogLogo :: (IsAboutDialog o, MonadIO m, IsPixbuf a) => a -> m (GValueConstruct o)
getAboutDialogLogo :: (MonadIO m, IsAboutDialog o) => o -> m Pixbuf
setAboutDialogLogo :: (MonadIO m, IsAboutDialog o, IsPixbuf a) => o -> a -> m ()
clearAboutDialogLogoIconName :: (MonadIO m, IsAboutDialog o) => o -> m ()
constructAboutDialogLogoIconName :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogLogoIconName :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogLogoIconName :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
constructAboutDialogProgramName :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogProgramName :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogProgramName :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
clearAboutDialogTranslatorCredits :: (MonadIO m, IsAboutDialog o) => o -> m ()
constructAboutDialogTranslatorCredits :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogTranslatorCredits :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogTranslatorCredits :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
clearAboutDialogVersion :: (MonadIO m, IsAboutDialog o) => o -> m ()
constructAboutDialogVersion :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogVersion :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogVersion :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
clearAboutDialogWebsite :: (MonadIO m, IsAboutDialog o) => o -> m ()
constructAboutDialogWebsite :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogWebsite :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogWebsite :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
constructAboutDialogWebsiteLabel :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogWebsiteLabel :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogWebsiteLabel :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
constructAboutDialogWrapLicense :: (IsAboutDialog o, MonadIO m) => Bool -> m (GValueConstruct o)
getAboutDialogWrapLicense :: (MonadIO m, IsAboutDialog o) => o -> m Bool
setAboutDialogWrapLicense :: (MonadIO m, IsAboutDialog o) => o -> Bool -> m ()
type AboutDialogActivateLinkCallback = Text -> IO Bool
type C_AboutDialogActivateLinkCallback = Ptr () -> CString -> Ptr () -> IO CInt
afterAboutDialogActivateLink :: (IsAboutDialog a, MonadIO m) => a -> AboutDialogActivateLinkCallback -> m SignalHandlerId
genClosure_AboutDialogActivateLink :: MonadIO m => AboutDialogActivateLinkCallback -> m (GClosure C_AboutDialogActivateLinkCallback)
mk_AboutDialogActivateLinkCallback :: C_AboutDialogActivateLinkCallback -> IO (FunPtr C_AboutDialogActivateLinkCallback)
noAboutDialogActivateLinkCallback :: Maybe AboutDialogActivateLinkCallback
onAboutDialogActivateLink :: (IsAboutDialog a, MonadIO m) => a -> AboutDialogActivateLinkCallback -> m SignalHandlerId
wrap_AboutDialogActivateLinkCallback :: AboutDialogActivateLinkCallback -> C_AboutDialogActivateLinkCallback

Exported types

newtype AboutDialog Source #

Memory-managed wrapper type.

Constructors

AboutDialog (ManagedPtr AboutDialog)

Instances

Instances details

Eq AboutDialog Source #
Instance details Defined in GI.Gtk.Objects.AboutDialog Methods (==) :: AboutDialog -> AboutDialog -> Bool # (/=) :: AboutDialog -> AboutDialog -> Bool #
GObject AboutDialog Source #
Instance details Defined in GI.Gtk.Objects.AboutDialog
ManagedPtrNewtype AboutDialog Source #
Instance details Defined in GI.Gtk.Objects.AboutDialog Methods toManagedPtr :: AboutDialog -> ManagedPtr AboutDialog
TypedObject AboutDialog Source #
Instance details Defined in GI.Gtk.Objects.AboutDialog Methods glibType :: IO GType
HasParentTypes AboutDialog Source #
Instance details Defined in GI.Gtk.Objects.AboutDialog
IsGValue (Maybe AboutDialog) Source #	Convert `AboutDialog` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.AboutDialog Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe AboutDialog -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe AboutDialog)
type ParentTypes AboutDialog Source #
Instance details Defined in GI.Gtk.Objects.AboutDialog type ParentTypes AboutDialog = '[Dialog, Window, Bin, Container, Widget, Object, ImplementorIface, Buildable]

class (GObject o, IsDescendantOf AboutDialog o) => IsAboutDialog o Source #

Type class for types which can be safely cast to AboutDialog, for instance with toAboutDialog.

Instances

Instances details

(GObject o, IsDescendantOf AboutDialog o) => IsAboutDialog o Source #
Instance details Defined in GI.Gtk.Objects.AboutDialog

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

Cast to AboutDialog, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Expand

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

aboutDialogGetLogo 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

aboutDialogSetLogo 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

GtkWidget *about = gtk_about_dialog_new ();
gtk_about_dialog_set_translator_credits (GTK_ABOUT_DIALOG (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

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

Since: 2.6

constructAboutDialogArtists :: (IsAboutDialog o, MonadIO m) => [Text] -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “artists” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “artists” property. When overloading is enabled, this is equivalent to

get aboutDialog #artists

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

Set the value of the “artists” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #artists := value ]

authors

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

Since: 2.6

constructAboutDialogAuthors :: (IsAboutDialog o, MonadIO m) => [Text] -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “authors” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “authors” property. When overloading is enabled, this is equivalent to

get aboutDialog #authors

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

Set the value of the “authors” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #authors := value ]

comments

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.

Since: 2.6

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

Set the value of the “comments” property to Nothing. When overloading is enabled, this is equivalent to

clear #comments

constructAboutDialogComments :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “comments” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “comments” property. When overloading is enabled, this is equivalent to

get aboutDialog #comments

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

Set the value of the “comments” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #comments := value ]

copyright

Copyright information for the program.

Since: 2.6

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

Set the value of the “copyright” property to Nothing. When overloading is enabled, this is equivalent to

clear #copyright

constructAboutDialogCopyright :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “copyright” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “copyright” property. When overloading is enabled, this is equivalent to

get aboutDialog #copyright

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

Set the value of the “copyright” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #copyright := value ]

documenters

The people documenting the program, as a Nothing-terminated array of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Since: 2.6

constructAboutDialogDocumenters :: (IsAboutDialog o, MonadIO m) => [Text] -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “documenters” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “documenters” property. When overloading is enabled, this is equivalent to

get aboutDialog #documenters

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

Set the value of the “documenters” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #documenters := value ]

license

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 "wrap-license" property is set to True; otherwise the text itself must contain the intended linebreaks. When setting this property to a non-Nothing value, the AboutDialog:license-type property is set to LicenseCustom as a side effect.

Since: 2.6

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

Set the value of the “license” property to Nothing. When overloading is enabled, this is equivalent to

clear #license

constructAboutDialogLicense :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “license” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “license” property. When overloading is enabled, this is equivalent to

get aboutDialog #license

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

Set the value of the “license” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #license := value ]

licenseType

The license of the program, as a value of the GtkLicense enumeration.

The AboutDialog will automatically fill out a standard disclaimer and link the user to the appropriate online resource for the license text.

If LicenseUnknown is used, the link used will be the same specified in the AboutDialog:website property.

If LicenseCustom is used, the current contents of the AboutDialog:license property are used.

For any other License value, the contents of the AboutDialog:license property are also set by this property as a side effect.

Since: 3.0

constructAboutDialogLicenseType :: (IsAboutDialog o, MonadIO m) => License -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “license-type” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “license-type” property. When overloading is enabled, this is equivalent to

get aboutDialog #licenseType

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

Set the value of the “license-type” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #licenseType := value ]

logo

A logo for the about box. If it is Nothing, the default window icon set with windowSetDefaultIcon will be used.

Since: 2.6

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

Set the value of the “logo” property to Nothing. When overloading is enabled, this is equivalent to

clear #logo

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

Construct a GValueConstruct with valid value for the “logo” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “logo” property. When overloading is enabled, this is equivalent to

get aboutDialog #logo

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

Set the value of the “logo” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #logo := value ]

logoIconName

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

Since: 2.6

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

Set the value of the “logo-icon-name” property to Nothing. When overloading is enabled, this is equivalent to

clear #logoIconName

constructAboutDialogLogoIconName :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “logo-icon-name” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “logo-icon-name” property. When overloading is enabled, this is equivalent to

get aboutDialog #logoIconName

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

Set the value of the “logo-icon-name” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #logoIconName := value ]

programName

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

Since: 2.12

constructAboutDialogProgramName :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “program-name” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “program-name” property. When overloading is enabled, this is equivalent to

get aboutDialog #programName

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

Set the value of the “program-name” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #programName := value ]

translatorCredits

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.

Since: 2.6

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

Set the value of the “translator-credits” property to Nothing. When overloading is enabled, this is equivalent to

clear #translatorCredits

constructAboutDialogTranslatorCredits :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “translator-credits” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “translator-credits” property. When overloading is enabled, this is equivalent to

get aboutDialog #translatorCredits

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

Set the value of the “translator-credits” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #translatorCredits := value ]

version

The version of the program.

Since: 2.6

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

Set the value of the “version” property to Nothing. When overloading is enabled, this is equivalent to

clear #version

constructAboutDialogVersion :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “version” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “version” property. When overloading is enabled, this is equivalent to

get aboutDialog #version

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

Set the value of the “version” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #version := value ]

website

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

Since: 2.6

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

Set the value of the “website” property to Nothing. When overloading is enabled, this is equivalent to

clear #website

constructAboutDialogWebsite :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “website” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “website” property. When overloading is enabled, this is equivalent to

get aboutDialog #website

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

Set the value of the “website” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #website := value ]

websiteLabel

The label for the link to the website of the program.

Since: 2.6

constructAboutDialogWebsiteLabel :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “website-label” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “website-label” property. When overloading is enabled, this is equivalent to

get aboutDialog #websiteLabel

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

Set the value of the “website-label” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #websiteLabel := value ]

wrapLicense

Whether to wrap the text in the license dialog.

Since: 2.8

constructAboutDialogWrapLicense :: (IsAboutDialog o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “wrap-license” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “wrap-license” property. When overloading is enabled, this is equivalent to

get aboutDialog #wrapLicense

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

Set the value of the “wrap-license” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #wrapLicense := value ]

Signals

activateLink

type AboutDialogActivateLinkCallback Source #

Arguments

= Text	`uri`: the URI that is activated
-> IO Bool	Returns: `True` if the link has been activated

The signal which gets emitted to activate a URI. Applications may connect to it to override the default behaviour, which is to call showUriOnWindow.

Since: 2.24

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

Type for the callback on the (unwrapped) C side.

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

Connect a signal handler for the activateLink signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after aboutDialog #activateLink callback

genClosure_AboutDialogActivateLink :: MonadIO m => AboutDialogActivateLinkCallback -> m (GClosure C_AboutDialogActivateLinkCallback) Source #

Wrap the callback into a GClosure.

mk_AboutDialogActivateLinkCallback :: C_AboutDialogActivateLinkCallback -> IO (FunPtr C_AboutDialogActivateLinkCallback) Source #

Generate a function pointer callable from C code, from a C_AboutDialogActivateLinkCallback.

noAboutDialogActivateLinkCallback :: Maybe AboutDialogActivateLinkCallback Source #

A convenience synonym for Nothing :: Maybe AboutDialogActivateLinkCallback.

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

Connect a signal handler for the activateLink signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on aboutDialog #activateLink callback

wrap_AboutDialogActivateLinkCallback :: AboutDialogActivateLinkCallback -> C_AboutDialogActivateLinkCallback Source #

Wrap a AboutDialogActivateLinkCallback into a C_AboutDialogActivateLinkCallback.

C code

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

addCreditSection

getArtists

getAuthors

getComments

getCopyright

getDocumenters

getLicense

getLicenseType

getLogo

getLogoIconName

getProgramName

getTranslatorCredits

getVersion

getWebsite

getWebsiteLabel

getWrapLicense

new

setArtists

setAuthors

setComments

setCopyright

setDocumenters

setLicense

setLicenseType

setLogo

setLogoIconName

setProgramName

setTranslatorCredits

C code

setVersion

setWebsite

setWebsiteLabel

setWrapLicense

Properties

artists

authors

comments

copyright

documenters

license

licenseType

logo

logoIconName

programName

translatorCredits

version

website

websiteLabel

wrapLicense

Signals

activateLink