Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
- Exported types
- Methods
- 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
- setVersion
- setWebsite
- setWebsiteLabel
- setWrapLicense
- Properties
- Signals
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.
- newtype AboutDialog = AboutDialog (ManagedPtr AboutDialog)
- class GObject o => IsAboutDialog o
- toAboutDialog :: IsAboutDialog o => o -> IO AboutDialog
- noAboutDialog :: Maybe AboutDialog
- data AboutDialogAddCreditSectionMethodInfo
- aboutDialogAddCreditSection :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> [Text] -> m ()
- data AboutDialogGetArtistsMethodInfo
- aboutDialogGetArtists :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m [Text]
- data AboutDialogGetAuthorsMethodInfo
- aboutDialogGetAuthors :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m [Text]
- data AboutDialogGetCommentsMethodInfo
- aboutDialogGetComments :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
- data AboutDialogGetCopyrightMethodInfo
- aboutDialogGetCopyright :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
- data AboutDialogGetDocumentersMethodInfo
- aboutDialogGetDocumenters :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m [Text]
- data AboutDialogGetLicenseMethodInfo
- aboutDialogGetLicense :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
- data AboutDialogGetLicenseTypeMethodInfo
- aboutDialogGetLicenseType :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m License
- data AboutDialogGetLogoMethodInfo
- aboutDialogGetLogo :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Pixbuf
- data AboutDialogGetLogoIconNameMethodInfo
- aboutDialogGetLogoIconName :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
- data AboutDialogGetProgramNameMethodInfo
- aboutDialogGetProgramName :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
- data AboutDialogGetTranslatorCreditsMethodInfo
- aboutDialogGetTranslatorCredits :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
- data AboutDialogGetVersionMethodInfo
- aboutDialogGetVersion :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
- data AboutDialogGetWebsiteMethodInfo
- aboutDialogGetWebsite :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
- data AboutDialogGetWebsiteLabelMethodInfo
- aboutDialogGetWebsiteLabel :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
- data AboutDialogGetWrapLicenseMethodInfo
- aboutDialogGetWrapLicense :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Bool
- aboutDialogNew :: (HasCallStack, MonadIO m) => m AboutDialog
- data AboutDialogSetArtistsMethodInfo
- aboutDialogSetArtists :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> [Text] -> m ()
- data AboutDialogSetAuthorsMethodInfo
- aboutDialogSetAuthors :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> [Text] -> m ()
- data AboutDialogSetCommentsMethodInfo
- aboutDialogSetComments :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> m ()
- data AboutDialogSetCopyrightMethodInfo
- aboutDialogSetCopyright :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> m ()
- data AboutDialogSetDocumentersMethodInfo
- aboutDialogSetDocumenters :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> [Text] -> m ()
- data AboutDialogSetLicenseMethodInfo
- aboutDialogSetLicense :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> m ()
- data AboutDialogSetLicenseTypeMethodInfo
- aboutDialogSetLicenseType :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> License -> m ()
- data AboutDialogSetLogoMethodInfo
- aboutDialogSetLogo :: (HasCallStack, MonadIO m, IsAboutDialog a, IsPixbuf b) => a -> Maybe b -> m ()
- data AboutDialogSetLogoIconNameMethodInfo
- aboutDialogSetLogoIconName :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> m ()
- data AboutDialogSetProgramNameMethodInfo
- aboutDialogSetProgramName :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
- data AboutDialogSetTranslatorCreditsMethodInfo
- aboutDialogSetTranslatorCredits :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> m ()
- data AboutDialogSetVersionMethodInfo
- aboutDialogSetVersion :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> m ()
- data AboutDialogSetWebsiteMethodInfo
- aboutDialogSetWebsite :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> m ()
- data AboutDialogSetWebsiteLabelMethodInfo
- aboutDialogSetWebsiteLabel :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
- data AboutDialogSetWrapLicenseMethodInfo
- aboutDialogSetWrapLicense :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Bool -> m ()
- data AboutDialogArtistsPropertyInfo
- aboutDialogArtists :: AttrLabelProxy "artists"
- constructAboutDialogArtists :: IsAboutDialog o => [Text] -> IO (GValueConstruct o)
- getAboutDialogArtists :: (MonadIO m, IsAboutDialog o) => o -> m [Text]
- setAboutDialogArtists :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m ()
- data AboutDialogAuthorsPropertyInfo
- aboutDialogAuthors :: AttrLabelProxy "authors"
- constructAboutDialogAuthors :: IsAboutDialog o => [Text] -> IO (GValueConstruct o)
- getAboutDialogAuthors :: (MonadIO m, IsAboutDialog o) => o -> m [Text]
- setAboutDialogAuthors :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m ()
- data AboutDialogCommentsPropertyInfo
- aboutDialogComments :: AttrLabelProxy "comments"
- clearAboutDialogComments :: (MonadIO m, IsAboutDialog o) => o -> m ()
- constructAboutDialogComments :: IsAboutDialog o => Text -> IO (GValueConstruct o)
- getAboutDialogComments :: (MonadIO m, IsAboutDialog o) => o -> m Text
- setAboutDialogComments :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
- data AboutDialogCopyrightPropertyInfo
- aboutDialogCopyright :: AttrLabelProxy "copyright"
- clearAboutDialogCopyright :: (MonadIO m, IsAboutDialog o) => o -> m ()
- constructAboutDialogCopyright :: IsAboutDialog o => Text -> IO (GValueConstruct o)
- getAboutDialogCopyright :: (MonadIO m, IsAboutDialog o) => o -> m Text
- setAboutDialogCopyright :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
- data AboutDialogDocumentersPropertyInfo
- aboutDialogDocumenters :: AttrLabelProxy "documenters"
- constructAboutDialogDocumenters :: IsAboutDialog o => [Text] -> IO (GValueConstruct o)
- getAboutDialogDocumenters :: (MonadIO m, IsAboutDialog o) => o -> m [Text]
- setAboutDialogDocumenters :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m ()
- data AboutDialogLicensePropertyInfo
- aboutDialogLicense :: AttrLabelProxy "license"
- clearAboutDialogLicense :: (MonadIO m, IsAboutDialog o) => o -> m ()
- constructAboutDialogLicense :: IsAboutDialog o => Text -> IO (GValueConstruct o)
- getAboutDialogLicense :: (MonadIO m, IsAboutDialog o) => o -> m Text
- setAboutDialogLicense :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
- data AboutDialogLicenseTypePropertyInfo
- aboutDialogLicenseType :: AttrLabelProxy "licenseType"
- constructAboutDialogLicenseType :: IsAboutDialog o => License -> IO (GValueConstruct o)
- getAboutDialogLicenseType :: (MonadIO m, IsAboutDialog o) => o -> m License
- setAboutDialogLicenseType :: (MonadIO m, IsAboutDialog o) => o -> License -> m ()
- data AboutDialogLogoPropertyInfo
- aboutDialogLogo :: AttrLabelProxy "logo"
- clearAboutDialogLogo :: (MonadIO m, IsAboutDialog o) => o -> m ()
- constructAboutDialogLogo :: (IsAboutDialog o, IsPixbuf a) => a -> IO (GValueConstruct o)
- getAboutDialogLogo :: (MonadIO m, IsAboutDialog o) => o -> m Pixbuf
- setAboutDialogLogo :: (MonadIO m, IsAboutDialog o, IsPixbuf a) => o -> a -> m ()
- data AboutDialogLogoIconNamePropertyInfo
- aboutDialogLogoIconName :: AttrLabelProxy "logoIconName"
- clearAboutDialogLogoIconName :: (MonadIO m, IsAboutDialog o) => o -> m ()
- constructAboutDialogLogoIconName :: IsAboutDialog o => Text -> IO (GValueConstruct o)
- getAboutDialogLogoIconName :: (MonadIO m, IsAboutDialog o) => o -> m Text
- setAboutDialogLogoIconName :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
- data AboutDialogProgramNamePropertyInfo
- aboutDialogProgramName :: AttrLabelProxy "programName"
- constructAboutDialogProgramName :: IsAboutDialog o => Text -> IO (GValueConstruct o)
- getAboutDialogProgramName :: (MonadIO m, IsAboutDialog o) => o -> m Text
- setAboutDialogProgramName :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
- data AboutDialogTranslatorCreditsPropertyInfo
- aboutDialogTranslatorCredits :: AttrLabelProxy "translatorCredits"
- clearAboutDialogTranslatorCredits :: (MonadIO m, IsAboutDialog o) => o -> m ()
- constructAboutDialogTranslatorCredits :: IsAboutDialog o => Text -> IO (GValueConstruct o)
- getAboutDialogTranslatorCredits :: (MonadIO m, IsAboutDialog o) => o -> m Text
- setAboutDialogTranslatorCredits :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
- data AboutDialogVersionPropertyInfo
- aboutDialogVersion :: AttrLabelProxy "version"
- clearAboutDialogVersion :: (MonadIO m, IsAboutDialog o) => o -> m ()
- constructAboutDialogVersion :: IsAboutDialog o => Text -> IO (GValueConstruct o)
- getAboutDialogVersion :: (MonadIO m, IsAboutDialog o) => o -> m Text
- setAboutDialogVersion :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
- data AboutDialogWebsitePropertyInfo
- aboutDialogWebsite :: AttrLabelProxy "website"
- clearAboutDialogWebsite :: (MonadIO m, IsAboutDialog o) => o -> m ()
- constructAboutDialogWebsite :: IsAboutDialog o => Text -> IO (GValueConstruct o)
- getAboutDialogWebsite :: (MonadIO m, IsAboutDialog o) => o -> m Text
- setAboutDialogWebsite :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
- data AboutDialogWebsiteLabelPropertyInfo
- aboutDialogWebsiteLabel :: AttrLabelProxy "websiteLabel"
- constructAboutDialogWebsiteLabel :: IsAboutDialog o => Text -> IO (GValueConstruct o)
- getAboutDialogWebsiteLabel :: (MonadIO m, IsAboutDialog o) => o -> m Text
- setAboutDialogWebsiteLabel :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
- data AboutDialogWrapLicensePropertyInfo
- aboutDialogWrapLicense :: AttrLabelProxy "wrapLicense"
- constructAboutDialogWrapLicense :: IsAboutDialog o => Bool -> IO (GValueConstruct o)
- getAboutDialogWrapLicense :: (MonadIO m, IsAboutDialog o) => o -> m Bool
- setAboutDialogWrapLicense :: (MonadIO m, IsAboutDialog o) => o -> Bool -> m ()
- type AboutDialogActivateLinkCallback = Text -> IO Bool
- data AboutDialogActivateLinkSignalInfo
- type C_AboutDialogActivateLinkCallback = Ptr () -> CString -> Ptr () -> IO CInt
- afterAboutDialogActivateLink :: (GObject a, MonadIO m) => a -> AboutDialogActivateLinkCallback -> m SignalHandlerId
- genClosure_AboutDialogActivateLink :: AboutDialogActivateLinkCallback -> IO Closure
- mk_AboutDialogActivateLinkCallback :: C_AboutDialogActivateLinkCallback -> IO (FunPtr C_AboutDialogActivateLinkCallback)
- noAboutDialogActivateLinkCallback :: Maybe AboutDialogActivateLinkCallback
- onAboutDialogActivateLink :: (GObject a, MonadIO m) => a -> AboutDialogActivateLinkCallback -> m SignalHandlerId
- wrap_AboutDialogActivateLinkCallback :: AboutDialogActivateLinkCallback -> Ptr () -> CString -> Ptr () -> IO CInt
Exported types
newtype AboutDialog Source #
GObject AboutDialog Source # | |
IsImplementorIface AboutDialog Source # | |
IsObject AboutDialog Source # | |
IsWindow AboutDialog Source # | |
IsWidget AboutDialog Source # | |
IsDialog AboutDialog Source # | |
IsContainer AboutDialog Source # | |
IsBin AboutDialog Source # | |
IsBuildable AboutDialog Source # | |
IsAboutDialog AboutDialog Source # | |
((~) * info (ResolveAboutDialogMethod t AboutDialog), MethodInfo * info AboutDialog p) => IsLabel t (AboutDialog -> p) Source # | |
((~) * info (ResolveAboutDialogMethod t AboutDialog), MethodInfo * info AboutDialog p) => IsLabelProxy t (AboutDialog -> p) Source # | |
HasAttributeList * AboutDialog Source # | |
type AttributeList AboutDialog Source # | |
type SignalList AboutDialog Source # | |
class GObject o => IsAboutDialog o Source #
toAboutDialog :: IsAboutDialog o => o -> IO AboutDialog Source #
Methods
addCreditSection
data AboutDialogAddCreditSectionMethodInfo Source #
((~) * signature (Text -> [Text] -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogAddCreditSectionMethodInfo a signature Source # | |
aboutDialogAddCreditSection Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> Text |
|
-> [Text] |
|
-> m () |
Creates a new section in the Credits page.
Since: 3.4
getArtists
data AboutDialogGetArtistsMethodInfo Source #
((~) * signature (m [Text]), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetArtistsMethodInfo a signature Source # | |
aboutDialogGetArtists Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> m [Text] | Returns: A
|
Returns the string which are displayed in the artists tab of the secondary credits dialog.
Since: 2.6
getAuthors
data AboutDialogGetAuthorsMethodInfo Source #
((~) * signature (m [Text]), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetAuthorsMethodInfo a signature Source # | |
aboutDialogGetAuthors Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> m [Text] | Returns: A
|
Returns the string which are displayed in the authors tab of the secondary credits dialog.
Since: 2.6
getComments
data AboutDialogGetCommentsMethodInfo Source #
((~) * signature (m Text), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetCommentsMethodInfo a signature Source # | |
aboutDialogGetComments Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> 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
data AboutDialogGetCopyrightMethodInfo Source #
((~) * signature (m Text), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetCopyrightMethodInfo a signature Source # | |
aboutDialogGetCopyright Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> 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
data AboutDialogGetDocumentersMethodInfo Source #
((~) * signature (m [Text]), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetDocumentersMethodInfo a signature Source # | |
aboutDialogGetDocumenters Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> m [Text] | Returns: A
|
Returns the string which are displayed in the documenters tab of the secondary credits dialog.
Since: 2.6
getLicense
data AboutDialogGetLicenseMethodInfo Source #
((~) * signature (m Text), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetLicenseMethodInfo a signature Source # | |
aboutDialogGetLicense Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> 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
data AboutDialogGetLicenseTypeMethodInfo Source #
((~) * signature (m License), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetLicenseTypeMethodInfo a signature Source # | |
aboutDialogGetLicenseType Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> m License | Returns: a |
Retrieves the license set using aboutDialogSetLicenseType
Since: 3.0
getLogo
data AboutDialogGetLogoMethodInfo Source #
((~) * signature (m Pixbuf), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetLogoMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> 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 |
Returns the pixbuf displayed as logo in the about dialog.
Since: 2.6
getLogoIconName
data AboutDialogGetLogoIconNameMethodInfo Source #
((~) * signature (m Text), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetLogoIconNameMethodInfo a signature Source # | |
aboutDialogGetLogoIconName Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> 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 |
Returns the icon name displayed as logo in the about dialog.
Since: 2.6
getProgramName
data AboutDialogGetProgramNameMethodInfo Source #
((~) * signature (m Text), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetProgramNameMethodInfo a signature Source # | |
aboutDialogGetProgramName Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> 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
data AboutDialogGetTranslatorCreditsMethodInfo Source #
((~) * signature (m Text), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetTranslatorCreditsMethodInfo a signature Source # | |
aboutDialogGetTranslatorCredits Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> 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
data AboutDialogGetVersionMethodInfo Source #
((~) * signature (m Text), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetVersionMethodInfo a signature Source # | |
aboutDialogGetVersion Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> 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
data AboutDialogGetWebsiteMethodInfo Source #
((~) * signature (m Text), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetWebsiteMethodInfo a signature Source # | |
aboutDialogGetWebsite Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> 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
data AboutDialogGetWebsiteLabelMethodInfo Source #
((~) * signature (m Text), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetWebsiteLabelMethodInfo a signature Source # | |
aboutDialogGetWebsiteLabel Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> 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
data AboutDialogGetWrapLicenseMethodInfo Source #
((~) * signature (m Bool), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogGetWrapLicenseMethodInfo a signature Source # | |
aboutDialogGetWrapLicense Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the license text in about
is
automatically wrapped.
Since: 2.8
new
:: (HasCallStack, MonadIO m) | |
=> m AboutDialog | Returns: a newly created |
Creates a new AboutDialog
.
Since: 2.6
setArtists
data AboutDialogSetArtistsMethodInfo Source #
((~) * signature ([Text] -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogSetArtistsMethodInfo a signature Source # | |
aboutDialogSetArtists Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> [Text] |
|
-> m () |
Sets the strings which are displayed in the artists tab of the secondary credits dialog.
Since: 2.6
setAuthors
data AboutDialogSetAuthorsMethodInfo Source #
((~) * signature ([Text] -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogSetAuthorsMethodInfo a signature Source # | |
aboutDialogSetAuthors Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> [Text] |
|
-> m () |
Sets the strings which are displayed in the authors tab of the secondary credits dialog.
Since: 2.6
setComments
data AboutDialogSetCommentsMethodInfo Source #
((~) * signature (Maybe Text -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogSetCommentsMethodInfo a signature Source # | |
aboutDialogSetComments Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> Maybe Text |
|
-> 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
data AboutDialogSetCopyrightMethodInfo Source #
((~) * signature (Maybe Text -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogSetCopyrightMethodInfo a signature Source # | |
aboutDialogSetCopyright Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> Maybe Text |
|
-> 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
data AboutDialogSetDocumentersMethodInfo Source #
((~) * signature ([Text] -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogSetDocumentersMethodInfo a signature Source # | |
aboutDialogSetDocumenters Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> [Text] |
|
-> m () |
Sets the strings which are displayed in the documenters tab of the secondary credits dialog.
Since: 2.6
setLicense
data AboutDialogSetLicenseMethodInfo Source #
((~) * signature (Maybe Text -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogSetLicenseMethodInfo a signature Source # | |
aboutDialogSetLicense Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> Maybe Text |
|
-> 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
data AboutDialogSetLicenseTypeMethodInfo Source #
((~) * signature (License -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogSetLicenseTypeMethodInfo a signature Source # | |
aboutDialogSetLicenseType Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> 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
data AboutDialogSetLogoMethodInfo Source #
((~) * signature (Maybe b -> m ()), MonadIO m, IsAboutDialog a, IsPixbuf b) => MethodInfo * AboutDialogSetLogoMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsAboutDialog a, IsPixbuf b) | |
=> a |
|
-> Maybe b | |
-> 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
data AboutDialogSetLogoIconNameMethodInfo Source #
((~) * signature (Maybe Text -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogSetLogoIconNameMethodInfo a signature Source # | |
aboutDialogSetLogoIconName Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> Maybe Text |
|
-> 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
data AboutDialogSetProgramNameMethodInfo Source #
((~) * signature (Text -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogSetProgramNameMethodInfo a signature Source # | |
aboutDialogSetProgramName Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the name to display in the about dialog.
If this is not set, it defaults to getApplicationName
.
Since: 2.12
setTranslatorCredits
data AboutDialogSetTranslatorCreditsMethodInfo Source #
((~) * signature (Maybe Text -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogSetTranslatorCreditsMethodInfo a signature Source # | |
aboutDialogSetTranslatorCredits Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> Maybe Text |
|
-> 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
data AboutDialogSetVersionMethodInfo Source #
((~) * signature (Maybe Text -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogSetVersionMethodInfo a signature Source # | |
aboutDialogSetVersion Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Sets the version string to display in the about dialog.
Since: 2.6
setWebsite
data AboutDialogSetWebsiteMethodInfo Source #
((~) * signature (Maybe Text -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogSetWebsiteMethodInfo a signature Source # | |
aboutDialogSetWebsite Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Sets the URL to use for the website link.
Since: 2.6
setWebsiteLabel
data AboutDialogSetWebsiteLabelMethodInfo Source #
((~) * signature (Text -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogSetWebsiteLabelMethodInfo a signature Source # | |
aboutDialogSetWebsiteLabel Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the label to be used for the website link.
Since: 2.6
setWrapLicense
data AboutDialogSetWrapLicenseMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m, IsAboutDialog a) => MethodInfo * AboutDialogSetWrapLicenseMethodInfo a signature Source # | |
aboutDialogSetWrapLicense Source #
:: (HasCallStack, MonadIO m, IsAboutDialog a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the license text in about
is
automatically wrapped.
Since: 2.8
Properties
artists
data AboutDialogArtistsPropertyInfo Source #
aboutDialogArtists :: AttrLabelProxy "artists" Source #
constructAboutDialogArtists :: IsAboutDialog o => [Text] -> IO (GValueConstruct o) Source #
getAboutDialogArtists :: (MonadIO m, IsAboutDialog o) => o -> m [Text] Source #
setAboutDialogArtists :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m () Source #
authors
data AboutDialogAuthorsPropertyInfo Source #
aboutDialogAuthors :: AttrLabelProxy "authors" Source #
constructAboutDialogAuthors :: IsAboutDialog o => [Text] -> IO (GValueConstruct o) Source #
getAboutDialogAuthors :: (MonadIO m, IsAboutDialog o) => o -> m [Text] Source #
setAboutDialogAuthors :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m () Source #
comments
data AboutDialogCommentsPropertyInfo Source #
aboutDialogComments :: AttrLabelProxy "comments" Source #
clearAboutDialogComments :: (MonadIO m, IsAboutDialog o) => o -> m () Source #
constructAboutDialogComments :: IsAboutDialog o => Text -> IO (GValueConstruct o) Source #
getAboutDialogComments :: (MonadIO m, IsAboutDialog o) => o -> m Text Source #
setAboutDialogComments :: (MonadIO m, IsAboutDialog o) => o -> Text -> m () Source #
copyright
data AboutDialogCopyrightPropertyInfo Source #
aboutDialogCopyright :: AttrLabelProxy "copyright" Source #
clearAboutDialogCopyright :: (MonadIO m, IsAboutDialog o) => o -> m () Source #
constructAboutDialogCopyright :: IsAboutDialog o => Text -> IO (GValueConstruct o) Source #
getAboutDialogCopyright :: (MonadIO m, IsAboutDialog o) => o -> m Text Source #
setAboutDialogCopyright :: (MonadIO m, IsAboutDialog o) => o -> Text -> m () Source #
documenters
data AboutDialogDocumentersPropertyInfo Source #
aboutDialogDocumenters :: AttrLabelProxy "documenters" Source #
constructAboutDialogDocumenters :: IsAboutDialog o => [Text] -> IO (GValueConstruct o) Source #
getAboutDialogDocumenters :: (MonadIO m, IsAboutDialog o) => o -> m [Text] Source #
setAboutDialogDocumenters :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m () Source #
license
data AboutDialogLicensePropertyInfo Source #
aboutDialogLicense :: AttrLabelProxy "license" Source #
clearAboutDialogLicense :: (MonadIO m, IsAboutDialog o) => o -> m () Source #
constructAboutDialogLicense :: IsAboutDialog o => Text -> IO (GValueConstruct o) Source #
getAboutDialogLicense :: (MonadIO m, IsAboutDialog o) => o -> m Text Source #
setAboutDialogLicense :: (MonadIO m, IsAboutDialog o) => o -> Text -> m () Source #
licenseType
data AboutDialogLicenseTypePropertyInfo Source #
aboutDialogLicenseType :: AttrLabelProxy "licenseType" Source #
constructAboutDialogLicenseType :: IsAboutDialog o => License -> IO (GValueConstruct o) Source #
getAboutDialogLicenseType :: (MonadIO m, IsAboutDialog o) => o -> m License Source #
setAboutDialogLicenseType :: (MonadIO m, IsAboutDialog o) => o -> License -> m () Source #
logo
data AboutDialogLogoPropertyInfo Source #
aboutDialogLogo :: AttrLabelProxy "logo" Source #
clearAboutDialogLogo :: (MonadIO m, IsAboutDialog o) => o -> m () Source #
constructAboutDialogLogo :: (IsAboutDialog o, IsPixbuf a) => a -> IO (GValueConstruct o) Source #
getAboutDialogLogo :: (MonadIO m, IsAboutDialog o) => o -> m Pixbuf Source #
setAboutDialogLogo :: (MonadIO m, IsAboutDialog o, IsPixbuf a) => o -> a -> m () Source #
logoIconName
data AboutDialogLogoIconNamePropertyInfo Source #
aboutDialogLogoIconName :: AttrLabelProxy "logoIconName" Source #
clearAboutDialogLogoIconName :: (MonadIO m, IsAboutDialog o) => o -> m () Source #
constructAboutDialogLogoIconName :: IsAboutDialog o => Text -> IO (GValueConstruct o) Source #
getAboutDialogLogoIconName :: (MonadIO m, IsAboutDialog o) => o -> m Text Source #
setAboutDialogLogoIconName :: (MonadIO m, IsAboutDialog o) => o -> Text -> m () Source #
programName
data AboutDialogProgramNamePropertyInfo Source #
aboutDialogProgramName :: AttrLabelProxy "programName" Source #
constructAboutDialogProgramName :: IsAboutDialog o => Text -> IO (GValueConstruct o) Source #
getAboutDialogProgramName :: (MonadIO m, IsAboutDialog o) => o -> m Text Source #
setAboutDialogProgramName :: (MonadIO m, IsAboutDialog o) => o -> Text -> m () Source #
translatorCredits
data AboutDialogTranslatorCreditsPropertyInfo Source #
aboutDialogTranslatorCredits :: AttrLabelProxy "translatorCredits" Source #
clearAboutDialogTranslatorCredits :: (MonadIO m, IsAboutDialog o) => o -> m () Source #
constructAboutDialogTranslatorCredits :: IsAboutDialog o => Text -> IO (GValueConstruct o) Source #
getAboutDialogTranslatorCredits :: (MonadIO m, IsAboutDialog o) => o -> m Text Source #
setAboutDialogTranslatorCredits :: (MonadIO m, IsAboutDialog o) => o -> Text -> m () Source #
version
data AboutDialogVersionPropertyInfo Source #
aboutDialogVersion :: AttrLabelProxy "version" Source #
clearAboutDialogVersion :: (MonadIO m, IsAboutDialog o) => o -> m () Source #
constructAboutDialogVersion :: IsAboutDialog o => Text -> IO (GValueConstruct o) Source #
getAboutDialogVersion :: (MonadIO m, IsAboutDialog o) => o -> m Text Source #
setAboutDialogVersion :: (MonadIO m, IsAboutDialog o) => o -> Text -> m () Source #
website
data AboutDialogWebsitePropertyInfo Source #
aboutDialogWebsite :: AttrLabelProxy "website" Source #
clearAboutDialogWebsite :: (MonadIO m, IsAboutDialog o) => o -> m () Source #
constructAboutDialogWebsite :: IsAboutDialog o => Text -> IO (GValueConstruct o) Source #
getAboutDialogWebsite :: (MonadIO m, IsAboutDialog o) => o -> m Text Source #
setAboutDialogWebsite :: (MonadIO m, IsAboutDialog o) => o -> Text -> m () Source #
websiteLabel
data AboutDialogWebsiteLabelPropertyInfo Source #
aboutDialogWebsiteLabel :: AttrLabelProxy "websiteLabel" Source #
constructAboutDialogWebsiteLabel :: IsAboutDialog o => Text -> IO (GValueConstruct o) Source #
getAboutDialogWebsiteLabel :: (MonadIO m, IsAboutDialog o) => o -> m Text Source #
setAboutDialogWebsiteLabel :: (MonadIO m, IsAboutDialog o) => o -> Text -> m () Source #
wrapLicense
data AboutDialogWrapLicensePropertyInfo Source #
aboutDialogWrapLicense :: AttrLabelProxy "wrapLicense" Source #
constructAboutDialogWrapLicense :: IsAboutDialog o => Bool -> IO (GValueConstruct o) Source #
getAboutDialogWrapLicense :: (MonadIO m, IsAboutDialog o) => o -> m Bool Source #
setAboutDialogWrapLicense :: (MonadIO m, IsAboutDialog o) => o -> Bool -> m () Source #
Signals
activateLink
afterAboutDialogActivateLink :: (GObject a, MonadIO m) => a -> AboutDialogActivateLinkCallback -> m SignalHandlerId Source #
mk_AboutDialogActivateLinkCallback :: C_AboutDialogActivateLinkCallback -> IO (FunPtr C_AboutDialogActivateLinkCallback) Source #
onAboutDialogActivateLink :: (GObject a, MonadIO m) => a -> AboutDialogActivateLinkCallback -> m SignalHandlerId Source #
wrap_AboutDialogActivateLinkCallback :: AboutDialogActivateLinkCallback -> Ptr () -> CString -> Ptr () -> IO CInt Source #