GI.Gtk.Objects.AboutDialog

The GtkAboutDialog offers a simple way to display information about a program.

The shown information includes the programs' 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 fileLauncherLaunch when a user clicks one. The behaviour can be overridden with the AboutDialog::activateLink 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 https://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

GFile *logo_file = g_file_new_for_path ("./logo.png");
GdkTexture *example_logo = gdk_texture_new_from_file (logo_file, NULL);
g_object_unref (logo_file);

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

CSS nodes

GtkAboutDialog has a single CSS node with the name window and style class .aboutdialog.

Exported types

newtype AboutDialog

Memory-managed wrapper type.

Constructors

AboutDialog (ManagedPtr AboutDialog)

Instances

Eq AboutDialog

Defined in GI.Gtk.Objects.AboutDialog

Methods

(==) :: AboutDialog -> AboutDialog -> Bool

(/=) :: AboutDialog -> AboutDialog -> Bool

GObject AboutDialog

Defined in GI.Gtk.Objects.AboutDialog

ManagedPtrNewtype AboutDialog

Defined in GI.Gtk.Objects.AboutDialog

Methods

toManagedPtr :: AboutDialog -> ManagedPtr AboutDialog

TypedObject AboutDialog

Defined in GI.Gtk.Objects.AboutDialog

Methods

glibType :: IO GType

HasParentTypes AboutDialog

Defined in GI.Gtk.Objects.AboutDialog

IsGValue (Maybe AboutDialog)

Convert AboutDialog to and from GValue. See toGValue and fromGValue.

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

Defined in GI.Gtk.Objects.AboutDialog

type ParentTypes AboutDialog = '[Window, Widget, Object, Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager]

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

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

Instances

(GObject o, IsDescendantOf AboutDialog o) => IsAboutDialog o

Defined in GI.Gtk.Objects.AboutDialog

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

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

Methods

actionSetEnabled, activate, activateAction, activateDefault, addController, addCreditSection, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, close, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, destroy, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, fullscreen, fullscreenOnMonitor, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasGroup, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isActive, isAncestor, isDrawable, isFloating, isFocus, isFullscreen, isMaximized, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, maximize, measure, minimize, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, present, presentWithTime, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unfullscreen, unmap, unmaximize, unminimize, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleParent, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getApplication, getArtists, getAtContext, getAuthors, getBounds, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getColor, getComments, getCopyright, getCssClasses, getCssName, getCursor, getData, getDecorated, getDefaultSize, getDefaultWidget, getDeletable, getDestroyWithParent, getDirection, getDisplay, getDocumenters, getFirstAccessibleChild, getFirstChild, getFocus, getFocusChild, getFocusOnClick, getFocusVisible, getFocusable, getFontMap, getFontOptions, getFrameClock, getGroup, getHalign, getHandleMenubarAccel, getHasTooltip, getHeight, getHexpand, getHexpandSet, getHideOnClose, getIconName, getLastChild, getLayoutManager, getLicense, getLicenseType, getLogo, getLogoIconName, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMnemonicsVisible, getModal, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPlatformState, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProgramName, getProperty, getQdata, getRealized, getReceivesDefault, getRenderer, getRequestMode, getResizable, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getSurface, getSurfaceTransform, getSystemInformation, getTemplateChild, getTitle, getTitlebar, getTooltipMarkup, getTooltipText, getTransientFor, getTranslatorCredits, getValign, getVersion, getVexpand, getVexpandSet, getVisible, getWebsite, getWebsiteLabel, getWidth, getWrapLicense.

Setters

setAccessibleParent, setApplication, setArtists, setAuthors, setCanFocus, setCanTarget, setChild, setChildVisible, setComments, setCopyright, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDecorated, setDefaultSize, setDefaultWidget, setDeletable, setDestroyWithParent, setDirection, setDisplay, setDocumenters, setFocus, setFocusChild, setFocusOnClick, setFocusVisible, setFocusable, setFontMap, setFontOptions, setHalign, setHandleMenubarAccel, setHasTooltip, setHexpand, setHexpandSet, setHideOnClose, setIconName, setLayoutManager, setLicense, setLicenseType, setLogo, setLogoIconName, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setMnemonicsVisible, setModal, setName, setOpacity, setOverflow, setParent, setProgramName, setProperty, setReceivesDefault, setResizable, setSensitive, setSizeRequest, setStartupId, setStateFlags, setSystemInformation, setTitle, setTitlebar, setTooltipMarkup, setTooltipText, setTransientFor, setTranslatorCredits, setValign, setVersion, setVexpand, setVexpandSet, setVisible, setWebsite, setWebsiteLabel, setWrapLicense.

addCreditSection

aboutDialogAddCreditSection

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: A GtkAboutDialog

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

getArtists

aboutDialogGetArtists

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m [Text]

Returns: A NULL-terminated string array containing the artists

Returns the names of the artists which are displayed in the credits page.

getAuthors

aboutDialogGetAuthors

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m [Text]

Returns: A NULL-terminated string array containing the authors

Returns the names of the authors which are displayed in the credits page.

getComments

aboutDialogGetComments

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m (Maybe Text)

Returns: The comments

Returns the comments string.

getCopyright

aboutDialogGetCopyright

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m (Maybe Text)

Returns: The copyright string

Returns the copyright string.

getDocumenters

aboutDialogGetDocumenters

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m [Text]

Returns: A NULL-terminated string array containing the documenters

Returns the name of the documenters which are displayed in the credits page.

getLicense

aboutDialogGetLicense

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m (Maybe Text)

Returns: The license information

Returns the license information.

getLicenseType

aboutDialogGetLicenseType

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m License

Returns: a License value

Retrieves the license type.

getLogo

aboutDialogGetLogo

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m (Maybe Paintable)

Returns: the paintable displayed as logo or NULL if the logo is unset or has been set via aboutDialogSetLogoIconName

Returns the paintable displayed as logo in the about dialog.

getLogoIconName

aboutDialogGetLogoIconName

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m (Maybe Text)

Returns: the icon name displayed as logo, or NULL if the logo has been set via aboutDialogSetLogo

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

getProgramName

aboutDialogGetProgramName

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m (Maybe Text)

Returns: The program name

Returns the program name displayed in the about dialog.

getSystemInformation

aboutDialogGetSystemInformation

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m (Maybe Text)

Returns: the system information

Returns the system information that is shown in the about dialog.

getTranslatorCredits

aboutDialogGetTranslatorCredits

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m (Maybe Text)

Returns: The translator credits string

Returns the translator credits string which is displayed in the credits page.

getVersion

aboutDialogGetVersion

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m (Maybe Text)

Returns: The version string

Returns the version string.

getWebsite

aboutDialogGetWebsite

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m (Maybe Text)

Returns: The website URL

Returns the website URL.

getWebsiteLabel

aboutDialogGetWebsiteLabel

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m (Maybe Text)

Returns: The label used for the website link

Returns the label used for the website link.

getWrapLicense

aboutDialogGetWrapLicense

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> m Bool

Returns: TRUE if the license text is wrapped

Returns whether the license text in the about dialog is automatically wrapped.

new

aboutDialogNew

Arguments

:: (HasCallStack, MonadIO m)

=> m AboutDialog

Returns: a newly created GtkAboutDialog

Creates a new GtkAboutDialog.

setArtists

aboutDialogSetArtists

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> [Text]

artists: the authors of the artwork of the application

-> m ()

Sets the names of the artists to be displayed in the "Credits" page.

setAuthors

aboutDialogSetAuthors

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> [Text]

authors: the authors of the application

-> m ()

Sets the names of the authors which are displayed in the "Credits" page of the about dialog.

setComments

aboutDialogSetComments

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

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

setCopyright

aboutDialogSetCopyright

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

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

setDocumenters

aboutDialogSetDocumenters

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> [Text]

documenters: the authors of the documentation of the application

-> m ()

Sets the names of the documenters which are displayed in the "Credits" page.

setLicense

aboutDialogSetLicense

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> Maybe Text

license: the license information

-> m ()

Sets the license information to be displayed in the about dialog.

If license is NULL, the license page is hidden.

setLicenseType

aboutDialogSetLicenseType

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

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

setLogo

aboutDialogSetLogo

Arguments

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

=> a

about: a GtkAboutDialog

-> Maybe b

logo: a GdkPaintable

-> m ()

Sets the logo in the about dialog.

setLogoIconName

aboutDialogSetLogoIconName

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> Maybe Text

iconName: an icon name

-> m ()

Sets the icon name to be displayed as logo in the about dialog.

setProgramName

aboutDialogSetProgramName

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> Maybe Text

name: the program name

-> m ()

Sets the name to display in the about dialog.

If name is not set, the string returned by g_get_application_name() is used.

setSystemInformation

aboutDialogSetSystemInformation

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> Maybe Text

systemInformation: system information

-> m ()

Sets the system information to be displayed in the about dialog.

If system_information is NULL, the system information page is hidden.

See AboutDialog:systemInformation.

setTranslatorCredits

aboutDialogSetTranslatorCredits

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> Maybe Text

translatorCredits: the translator credits

-> m ()

Sets the translator credits string which is displayed in the credits page.

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 GtkAboutDialog will detect if “translator-credits” is untranslated and omit translator credits.

setVersion

aboutDialogSetVersion

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> Maybe Text

version: the version string

-> m ()

Sets the version string to display in the about dialog.

setWebsite

aboutDialogSetWebsite

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> Maybe Text

website: a URL string starting with http://

-> m ()

Sets the URL to use for the website link.

setWebsiteLabel

aboutDialogSetWebsiteLabel

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> Text

websiteLabel: the label used for the website link

-> m ()

Sets the label to be used for the website link.

setWrapLicense

aboutDialogSetWrapLicense

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)

=> a

about: a GtkAboutDialog

-> Bool

wrapLicense: whether to wrap the license

-> m ()

Sets whether the license text in the about dialog should be automatically wrapped.

Properties

artists

The people who contributed artwork to the program, as a NULL-terminated array of strings.

Each string may contain email addresses and URLs, which will be displayed as links.

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

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]

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

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 NULL-terminated array of strings.

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

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

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]

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

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.

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

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)

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 (Maybe Text)

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

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.

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

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)

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 (Maybe Text)

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

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 NULL-terminated array of strings.

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

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

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]

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

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, as free-form text.

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-NULL value, the AboutDialog:licenseType property is set to GTK_LICENSE_CUSTOM as a side effect.

The text may contain links in this format <http://www.some.place/> and email references in the form <[e-mail]>, and these will be converted into clickable links.

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

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)

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 (Maybe Text)

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

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.

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

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

If GTK_LICENSE_CUSTOM 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.

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

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

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

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 NULL, the default window icon set with windowSetDefaultIconName will be used.

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

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

clear #logo

constructAboutDialogLogo :: (IsAboutDialog o, MonadIO m, IsPaintable a) => a -> m (GValueConstruct o)

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 (Maybe Paintable)

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

get aboutDialog #logo

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

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.

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

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)

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 (Maybe Text)

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

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 the value returned by g_get_application_name().

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

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

clear #programName

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

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 (Maybe Text)

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

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

set aboutDialog [ #programName := value ]

systemInformation

Information about the system on which the program is running.

This information is displayed in a separate page, therefore it is fine to use a long multi-paragraph text. Note that the text should contain the intended linebreaks.

The text may contain links in this format <http://www.some.place/> and email references in the form <[e-mail]>, and these will be converted into clickable links.

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

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

clear #systemInformation

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

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

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

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

get aboutDialog #systemInformation

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

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

set aboutDialog [ #systemInformation := 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.

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

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)

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 (Maybe Text)

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

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.

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

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)

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 (Maybe Text)

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

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:// or https://.

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

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)

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 (Maybe Text)

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

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.

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

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 (Maybe Text)

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

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.

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

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

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

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

set aboutDialog [ #wrapLicense := value ]

Signals

activateLink

type AboutDialogActivateLinkCallback

Arguments

 = Text

uri: the URI that is activated

-> IO Bool

Returns: TRUE if the link has been activated

Emitted every time a URL is activated.

Applications may connect to it to override the default behaviour, which is to call fileLauncherLaunch.

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

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

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

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