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

GI.Adw.Objects.AboutDialog

Contents

Exported types
Methods
Properties
Signals
- activateLink

Description

A dialog showing information about the application.

an about dialog is typically opened when the user activates the About … item in the application's primary menu. All parts of the dialog are optional.

Main page

AdwAboutDialog prominently displays the application's icon, name, developer name and version. They can be set with the [propertyaboutDialog:application-icon], [propertyaboutDialog:application-name], [propertyaboutDialog:developer-name] and [propertyaboutDialog:version] respectively.

What's New

AdwAboutDialog provides a way for applications to display their release notes, set with the [propertyaboutDialog:release-notes] property.

Release notes are formatted the same way as AppStream descriptions.

The supported formatting options are:

Paragraph ()
Ordered list (<ol>), with list items (<li>)
Unordered list (<ul>), with list items (<li>)

Within paragraphs and list items, emphasis () and inline code (<code>) text styles are supported. The emphasis is rendered in italic, while inline code is shown in a monospaced font.

Any text outside paragraphs or list items is ignored.

Nested lists are not supported.

Only one version can be shown at a time. By default, the displayed version number matches [propertyaboutDialog:version]. Use [propertyaboutDialog:release-notes-version] to override it.

Details

The Details page displays the application comments and links.

The comments can be set with the [propertyaboutDialog:comments] property. Unlike AboutDialog:comments, this string can be long and detailed. It can also contain links and Pango markup.

To set the application website, use [propertyaboutDialog:website]. To add extra links below the website, use [methodaboutDialog.add_link].

If the Details page doesn't have any other content besides website, the website will be displayed on the main page instead.

Troubleshooting

AdwAboutDialog displays the following two links on the main page:

Support Questions, set with the [propertyaboutDialog:support-url] property,
Report an Issue, set with the [propertyaboutDialog:issue-url] property.

Additionally, applications can provide debugging information. It will be shown separately on the Troubleshooting page. Use the [propertyaboutDialog:debug-info] property to specify it.

It's intended to be attached to issue reports when reporting issues against the application. As such, it cannot contain markup or links.

AdwAboutDialog provides a quick way to save debug information to a file. When saving, [propertyaboutDialog:debug-info-filename] would be used as the suggested filename.

Credits and Acknowledgements

The Credits page has the following default sections:

Developers, set with the [propertyaboutDialog:developers] property,
Designers, set with the [propertyaboutDialog:designers] property,
Artists, set with the [propertyaboutDialog:artists] property,
Documenters, set with the [propertyaboutDialog:documenters] property,
Translators, set with the [propertyaboutDialog:translator-credits] property.

When setting translator credits, use the strings "translator-credits" or "translator_credits" and mark them as translatable.

The default sections that don't contain any names won't be displayed.

The Credits page can also contain an arbitrary number of extra sections below the default ones. Use [methodaboutDialog.add_credit_section] to add them.

The Acknowledgements page can be used to acknowledge additional people and organizations for their non-development contributions. Use [methodaboutDialog.add_acknowledgement_section] to add sections to it. For example, it can be used to list backers in a crowdfunded project or to give special thanks.

Each of the people or organizations can have an email address or a website specified. To add a email address, use a string like Edgar Allan Poe <edgar@poe.com>. To specify a website with a title, use a string like The GNOME Project https://www.gnome.org:

Legal

The Legal page displays the copyright and licensing information for the application and other modules.

Licensing information can be quickly set from a list of known licenses with the [propertyaboutDialog:license-type] property. If the application's license is not in the list, [propertyaboutDialog:license] can be used instead.

To add information about other modules, such as application dependencies or data, use [methodaboutDialog.add_legal_section].

Constructing

To make constructing an AdwAboutDialog as convenient as possible, you can use the function [funcshowAboutDialog] which constructs and shows a dialog.

c code

static void
show_about (GtkApplication *app)
{
  const char *developers[] = {
    "Angela Avery",
    NULL
  };

  const char *designers[] = {
    "GNOME Design Team",
    NULL
  };

  adw_show_about_dialog (GTK_WIDGET (gtk_application_get_active_window (app)),
                         "application-name", _("Example"),
                         "application-icon", "org.example.App",
                         "version", "1.2.3",
                         "copyright", "© 2022 Angela Avery",
                         "issue-url", "https://gitlab.gnome.org/example/example/-/issues/new",
                         "license-type", GTK_LICENSE_GPL_3_0,
                         "developers", developers,
                         "designers", designers,
                         "translator-credits", _("translator-credits"),
                         NULL);
}

CSS nodes

AdwAboutDialog has a main CSS node with the name dialog and the style class .about.

Since: 1.5

Synopsis

newtype AboutDialog = AboutDialog (ManagedPtr AboutDialog)
class (GObject o, IsDescendantOf AboutDialog o) => IsAboutDialog o
toAboutDialog :: (MonadIO m, IsAboutDialog o) => o -> m AboutDialog
aboutDialogAddAcknowledgementSection :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> [Text] -> m ()
aboutDialogAddCreditSection :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe Text -> [Text] -> m ()
aboutDialogAddLegalSection :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> Maybe Text -> License -> Maybe Text -> m ()
aboutDialogAddLink :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> Text -> m ()
aboutDialogGetApplicationIcon :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetApplicationName :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetArtists :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m (Maybe [Text])
aboutDialogGetComments :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetCopyright :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetDebugInfo :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetDebugInfoFilename :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetDesigners :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m (Maybe [Text])
aboutDialogGetDeveloperName :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetDevelopers :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m (Maybe [Text])
aboutDialogGetDocumenters :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m (Maybe [Text])
aboutDialogGetIssueUrl :: (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
aboutDialogGetReleaseNotes :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetReleaseNotesVersion :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> m Text
aboutDialogGetSupportUrl :: (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
aboutDialogNew :: (HasCallStack, MonadIO m) => m AboutDialog
aboutDialogNewFromAppdata :: (HasCallStack, MonadIO m) => Text -> Maybe Text -> m AboutDialog
aboutDialogSetApplicationIcon :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetApplicationName :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetArtists :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe [Text] -> m ()
aboutDialogSetComments :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetCopyright :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetDebugInfo :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetDebugInfoFilename :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetDesigners :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe [Text] -> m ()
aboutDialogSetDeveloperName :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetDevelopers :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe [Text] -> m ()
aboutDialogSetDocumenters :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Maybe [Text] -> m ()
aboutDialogSetIssueUrl :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetLicense :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetLicenseType :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> License -> m ()
aboutDialogSetReleaseNotes :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetReleaseNotesVersion :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetSupportUrl :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetTranslatorCredits :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetVersion :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
aboutDialogSetWebsite :: (HasCallStack, MonadIO m, IsAboutDialog a) => a -> Text -> m ()
constructAboutDialogApplicationIcon :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogApplicationIcon :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogApplicationIcon :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
constructAboutDialogApplicationName :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogApplicationName :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogApplicationName :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
clearAboutDialogArtists :: (MonadIO m, IsAboutDialog o) => o -> m ()
constructAboutDialogArtists :: (IsAboutDialog o, MonadIO m) => [Text] -> m (GValueConstruct o)
getAboutDialogArtists :: (MonadIO m, IsAboutDialog o) => o -> m (Maybe [Text])
setAboutDialogArtists :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> 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 ()
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 ()
constructAboutDialogDebugInfo :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogDebugInfo :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogDebugInfo :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
constructAboutDialogDebugInfoFilename :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogDebugInfoFilename :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogDebugInfoFilename :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
clearAboutDialogDesigners :: (MonadIO m, IsAboutDialog o) => o -> m ()
constructAboutDialogDesigners :: (IsAboutDialog o, MonadIO m) => [Text] -> m (GValueConstruct o)
getAboutDialogDesigners :: (MonadIO m, IsAboutDialog o) => o -> m (Maybe [Text])
setAboutDialogDesigners :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m ()
constructAboutDialogDeveloperName :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogDeveloperName :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogDeveloperName :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
clearAboutDialogDevelopers :: (MonadIO m, IsAboutDialog o) => o -> m ()
constructAboutDialogDevelopers :: (IsAboutDialog o, MonadIO m) => [Text] -> m (GValueConstruct o)
getAboutDialogDevelopers :: (MonadIO m, IsAboutDialog o) => o -> m (Maybe [Text])
setAboutDialogDevelopers :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m ()
clearAboutDialogDocumenters :: (MonadIO m, IsAboutDialog o) => o -> m ()
constructAboutDialogDocumenters :: (IsAboutDialog o, MonadIO m) => [Text] -> m (GValueConstruct o)
getAboutDialogDocumenters :: (MonadIO m, IsAboutDialog o) => o -> m (Maybe [Text])
setAboutDialogDocumenters :: (MonadIO m, IsAboutDialog o) => o -> [Text] -> m ()
constructAboutDialogIssueUrl :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogIssueUrl :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogIssueUrl :: (MonadIO m, IsAboutDialog o) => o -> Text -> 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 ()
constructAboutDialogReleaseNotes :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogReleaseNotes :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogReleaseNotes :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
constructAboutDialogReleaseNotesVersion :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogReleaseNotesVersion :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogReleaseNotesVersion :: (MonadIO m, IsAboutDialog o) => o -> Text -> m ()
constructAboutDialogSupportUrl :: (IsAboutDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getAboutDialogSupportUrl :: (MonadIO m, IsAboutDialog o) => o -> m Text
setAboutDialogSupportUrl :: (MonadIO m, IsAboutDialog o) => o -> Text -> 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 ()
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 ()
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 ()
type AboutDialogActivateLinkCallback = Text -> IO Bool
afterAboutDialogActivateLink :: (IsAboutDialog a, MonadIO m) => a -> ((?self :: a) => AboutDialogActivateLinkCallback) -> m SignalHandlerId
onAboutDialogActivateLink :: (IsAboutDialog a, MonadIO m) => a -> ((?self :: a) => AboutDialogActivateLinkCallback) -> m SignalHandlerId

Exported types

newtype AboutDialog Source #

Memory-managed wrapper type.

Constructors

AboutDialog (ManagedPtr AboutDialog)

Instances

Instances details

Eq AboutDialog Source #
Instance details Defined in GI.Adw.Objects.AboutDialog Methods (==) :: AboutDialog -> AboutDialog -> Bool # (/=) :: AboutDialog -> AboutDialog -> Bool #
GObject AboutDialog Source #
Instance details Defined in GI.Adw.Objects.AboutDialog
ManagedPtrNewtype AboutDialog Source #
Instance details Defined in GI.Adw.Objects.AboutDialog Methods toManagedPtr :: AboutDialog -> ManagedPtr AboutDialog
TypedObject AboutDialog Source #
Instance details Defined in GI.Adw.Objects.AboutDialog Methods glibType :: IO GType
HasParentTypes AboutDialog Source #
Instance details Defined in GI.Adw.Objects.AboutDialog
IsGValue (Maybe AboutDialog) Source #	Convert `AboutDialog` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Adw.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.Adw.Objects.AboutDialog type ParentTypes AboutDialog = '[Dialog, Widget, Object, Accessible, Buildable, ConstraintTarget]

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

addAcknowledgementSection

aboutDialogAddAcknowledgementSection Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Maybe Text	`name`: the section name
-> [Text]	`people`: the list of names
-> m ()

Adds a section to the Acknowledgements page.

This can be used to acknowledge additional people and organizations for their non-development contributions - for example, backers in a crowdfunded project.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[propertyaboutDialog:developers]
[propertyaboutDialog:designers]
[propertyaboutDialog:artists]
[propertyaboutDialog:documenters]
[propertyaboutDialog:translator-credits]
[methodaboutDialog.add_credit_section]

Since: 1.5

addCreditSection

aboutDialogAddCreditSection Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Maybe Text	`name`: the section name
-> [Text]	`people`: the list of names
-> m ()

Adds an extra section to the Credits page.

Extra sections are displayed below the standard categories.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[propertyaboutDialog:developers]
[propertyaboutDialog:designers]
[propertyaboutDialog:artists]
[propertyaboutDialog:documenters]
[propertyaboutDialog:translator-credits]
[methodaboutDialog.add_acknowledgement_section]

Since: 1.5

addLegalSection

aboutDialogAddLegalSection Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`title`: the name of the section
-> Maybe Text	`copyright`: a copyright string
-> License	`licenseType`: the type of license
-> Maybe Text	`license`: custom license information
-> m ()

Adds an extra section to the Legal page.

Extra sections will be displayed below the application's own information.

The parameters copyright, licenseType and license will be used to present the it the same way as [propertyaboutDialog:copyright], [propertyaboutDialog:license-type] and [propertyaboutDialog:license] are for the application's own information.

See those properties for more details.

This can be useful to attribute the application dependencies or data.

Examples:

c code

adw_about_dialog_add_legal_section (ADW_ABOUT_DIALOG (about),
                                    _("Copyright and a known license"),
                                    "© 2022 Example",
                                    GTK_LICENSE_LGPL_2_1,
                                    NULL);

adw_about_dialog_add_legal_section (ADW_ABOUT_DIALOG (about),
                                    _("Copyright and custom license"),
                                    "© 2022 Example",
                                    GTK_LICENSE_CUSTOM,
                                    "Custom license text");

adw_about_dialog_add_legal_section (ADW_ABOUT_DIALOG (about),
                                    _("Copyright only"),
                                    "© 2022 Example",
                                    GTK_LICENSE_UNKNOWN,
                                    NULL);

adw_about_dialog_add_legal_section (ADW_ABOUT_DIALOG (about),
                                    _("Custom license only"),
                                    NULL,
                                    GTK_LICENSE_CUSTOM,
                                    "Something completely custom here.");

Since: 1.5

addLink

aboutDialogAddLink Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`title`: the link title
-> Text	`url`: the link URL
-> m ()

Adds an extra link to the Details page.

Extra links are displayed under the comment and website.

Underlines in title will be interpreted as indicating a mnemonic.

See [propertyaboutDialog:website].

Since: 1.5

getApplicationIcon

aboutDialogGetApplicationIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: the application icon name

Gets the name of the application icon for self.

Since: 1.5

getApplicationName

aboutDialogGetApplicationName Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: the application name

Gets the application name for self.

Since: 1.5

getArtists

aboutDialogGetArtists Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m (Maybe [Text])	Returns: The list of artists

Gets the list of artists of the application.

Since: 1.5

getComments

aboutDialogGetComments Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: the comments

Gets the comments about the application.

Since: 1.5

getCopyright

aboutDialogGetCopyright Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: the copyright information

Gets the copyright information for self.

Since: 1.5

getDebugInfo

aboutDialogGetDebugInfo Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: the debug information

Gets the debug information for self.

Since: 1.5

getDebugInfoFilename

aboutDialogGetDebugInfoFilename Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: the debug information filename

Gets the debug information filename for self.

Since: 1.5

getDesigners

aboutDialogGetDesigners Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m (Maybe [Text])	Returns: The list of designers

Gets the list of designers of the application.

Since: 1.5

getDeveloperName

aboutDialogGetDeveloperName Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: the developer_name

Gets the developer name for self.

Since: 1.5

getDevelopers

aboutDialogGetDevelopers Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m (Maybe [Text])	Returns: The list of developers

Gets the list of developers of the application.

Since: 1.5

getDocumenters

aboutDialogGetDocumenters Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m (Maybe [Text])	Returns: The list of documenters

Gets the list of documenters of the application.

Since: 1.5

getIssueUrl

aboutDialogGetIssueUrl Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: the issue tracker URL

Gets the issue tracker URL for self.

Since: 1.5

getLicense

aboutDialogGetLicense Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: the license

Gets the license for self.

Since: 1.5

getLicenseType

aboutDialogGetLicenseType Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m License	Returns: the license type

Gets the license type for self.

Since: 1.5

getReleaseNotes

aboutDialogGetReleaseNotes Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: the release notes

Gets the release notes for self.

Since: 1.5

getReleaseNotesVersion

aboutDialogGetReleaseNotesVersion Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: the release notes version

Gets the version described by the application's release notes.

Since: 1.5

getSupportUrl

aboutDialogGetSupportUrl Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: the support page URL

Gets the URL of the support page for self.

Since: 1.5

getTranslatorCredits

aboutDialogGetTranslatorCredits Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: The translator credits string

Gets the translator credits string.

Since: 1.5

getVersion

aboutDialogGetVersion Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: the version

Gets the version for self.

Since: 1.5

getWebsite

aboutDialogGetWebsite Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> m Text	Returns: the website URL

Gets the application website URL for self.

Since: 1.5

new

aboutDialogNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m AboutDialog	Returns: the newly created `AdwAboutDialog`

Creates a new AdwAboutDialog.

Since: 1.5

newFromAppdata

aboutDialogNewFromAppdata Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`resourcePath`: The resource to use
-> Maybe Text	`releaseNotesVersion`: The version to retrieve release notes for
-> m AboutDialog	Returns: the newly created `AdwAboutDialog`

Creates a new AdwAboutDialog using AppStream metadata.

This automatically sets the following properties with the following AppStream values:

[propertyaboutDialog:application-icon] is set from the <id>
[propertyaboutDialog:application-name] is set from the <name>
[propertyaboutDialog:developer-name] is set from the <name> within <developer>
[propertyaboutDialog:version] is set from the version of the latest release
[propertyaboutDialog:website] is set from the <url type="homepage">
[propertyaboutDialog:support-url] is set from the <url type="help">
[propertyaboutDialog:issue-url] is set from the <url type="bugtracker">
[propertyaboutDialog:license-type] is set from the <project_license>. If the license type retrieved from AppStream is not listed in License, it will be set to GTK_LICENCE_CUSTOM.

If releaseNotesVersion is not NULL, [propertyaboutDialog:release-notes-version] is set to match it, while [propertyaboutDialog:release-notes] is set from the AppStream release description for that version.

Since: 1.5

setApplicationIcon

aboutDialogSetApplicationIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`applicationIcon`: the application icon name
-> m ()

Sets the name of the application icon for self.

The icon is displayed at the top of the main page.

Since: 1.5

setApplicationName

aboutDialogSetApplicationName Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`applicationName`: the application name
-> m ()

Sets the application name for self.

The name is displayed at the top of the main page.

Since: 1.5

setArtists

aboutDialogSetArtists Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Maybe [Text]	`artists`: the list of artists
-> m ()

Sets the list of artists of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[propertyaboutDialog:developers]
[propertyaboutDialog:designers]
[propertyaboutDialog:documenters]
[propertyaboutDialog:translator-credits]
[methodaboutDialog.add_credit_section]
[methodaboutDialog.add_acknowledgement_section]

Since: 1.5

setComments

aboutDialogSetComments Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`comments`: the comments
-> m ()

Sets the comments about the application.

Comments will be shown on the Details page, above links.

Unlike AboutDialog:comments, this string can be long and detailed. It can also contain links and Pango markup.

Since: 1.5

setCopyright

aboutDialogSetCopyright Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`copyright`: the copyright information
-> m ()

Sets the copyright information for self.

The copyright information will be displayed on the Legal page, before the application license.

methodaboutDialog.add_legal_section: can be used to add copyright information for the application dependencies or other components.

Since: 1.5

setDebugInfo

aboutDialogSetDebugInfo Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`debugInfo`: the debug information
-> m ()

Sets the debug information for self.

Debug information will be shown on the Troubleshooting page. It's intended to be attached to issue reports when reporting issues against the application.

AdwAboutDialog provides a quick way to save debug information to a file. When saving, [propertyaboutDialog:debug-info-filename] would be used as the suggested filename.

Debug information cannot contain markup or links.

Since: 1.5

setDebugInfoFilename

aboutDialogSetDebugInfoFilename Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`filename`: the debug info filename
-> m ()

Sets the debug information filename for self.

It will be used as the suggested filename when saving debug information to a file.

See [propertyaboutDialog:debug-info].

Since: 1.5

setDesigners

aboutDialogSetDesigners Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Maybe [Text]	`designers`: the list of designers
-> m ()

Sets the list of designers of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[propertyaboutDialog:developers]
[propertyaboutDialog:artists]
[propertyaboutDialog:documenters]
[propertyaboutDialog:translator-credits]
[methodaboutDialog.add_credit_section]
[methodaboutDialog.add_acknowledgement_section]

Since: 1.5

setDeveloperName

aboutDialogSetDeveloperName Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`developerName`: the developer name
-> m ()

Sets the developer name for self.

The developer name is displayed on the main page, under the application name.

If the application is developed by multiple people, the developer name can be set to values like "AppName team", "AppName developers" or "The AppName project", and the individual contributors can be listed on the Credits page, with [propertyaboutDialog:developers] and related properties.

Since: 1.5

setDevelopers

aboutDialogSetDevelopers Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Maybe [Text]	`developers`: the list of developers
-> m ()

Sets the list of developers of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[propertyaboutDialog:designers]
[propertyaboutDialog:artists]
[propertyaboutDialog:documenters]
[propertyaboutDialog:translator-credits]
[methodaboutDialog.add_credit_section]
[methodaboutDialog.add_acknowledgement_section]

Since: 1.5

setDocumenters

aboutDialogSetDocumenters Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Maybe [Text]	`documenters`: the list of documenters
-> m ()

Sets the list of documenters of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[propertyaboutDialog:developers]
[propertyaboutDialog:designers]
[propertyaboutDialog:artists]
[propertyaboutDialog:translator-credits]
[methodaboutDialog.add_credit_section]
[methodaboutDialog.add_acknowledgement_section]

Since: 1.5

setIssueUrl

aboutDialogSetIssueUrl Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`issueUrl`: the issue tracker URL
-> m ()

Sets the issue tracker URL for self.

The issue tracker link is displayed on the main page.

Since: 1.5

setLicense

aboutDialogSetLicense Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`license`: the license
-> m ()

Sets the license for self.

This can be used to set a custom text for the license if it can't be set via [propertyaboutDialog:license-type].

When set, [propertyaboutDialog:license-type] will be set to GTK_LICENSE_CUSTOM.

The license text will be displayed on the Legal page, below the copyright information.

License text can contain Pango markup and links.

methodaboutDialog.add_legal_section: can be used to add license information for the application dependencies or other components.

Since: 1.5

setLicenseType

aboutDialogSetLicenseType Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> License	`licenseType`: the license type
-> m ()

Sets the license for self from a list of known licenses.

If the application's license is not in the list, [propertyaboutDialog:license] can be used instead. The license type will be automatically set to GTK_LICENSE_CUSTOM in that case.

If licenseType is GTK_LICENSE_UNKNOWN, no information will be displayed.

If licenseType is different from GTK_LICENSE_CUSTOM. [propertyaboutDialog:license] will be cleared out.

The license description will be displayed on the Legal page, below the copyright information.

methodaboutDialog.add_legal_section: can be used to add license information for the application dependencies or other components.

Since: 1.5

setReleaseNotes

aboutDialogSetReleaseNotes Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`releaseNotes`: the release notes
-> m ()

Sets the release notes for self.

Release notes are displayed on the the What's New page.

Release notes are formatted the same way as AppStream descriptions.

The supported formatting options are:

Paragraph ()
Ordered list (<ol>), with list items (<li>)
Unordered list (<ul>), with list items (<li>)

Within paragraphs and list items, emphasis () and inline code (<code>) text styles are supported. The emphasis is rendered in italic, while inline code is shown in a monospaced font.

Any text outside paragraphs or list items is ignored.

Nested lists are not supported.

AdwAboutDialog displays the version above the release notes. If set, the [propertyaboutDialog:release-notes-version] of the property will be used as the version; otherwise, [propertyaboutDialog:version] is used.

Since: 1.5

setReleaseNotesVersion

aboutDialogSetReleaseNotesVersion Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`version`: the release notes version
-> m ()

Sets the version described by the application's release notes.

The release notes version is displayed on the What's New page, above the release notes.

If not set, [propertyaboutDialog:version] will be used instead.

For example, an application with the current version 2.0.2 might want to keep the release notes from 2.0.0, and set the release notes version accordingly.

See [propertyaboutDialog:release-notes].

Since: 1.5

setSupportUrl

aboutDialogSetSupportUrl Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`supportUrl`: the support page URL
-> m ()

Sets the URL of the support page for self.

The support page link is displayed on the main page.

Since: 1.5

setTranslatorCredits

aboutDialogSetTranslatorCredits Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`translatorCredits`: the translator credits
-> m ()

Sets the translator credits string.

It will be displayed on the Credits page.

This string should be "translator-credits" or "translator_credits" and should be marked as translatable.

The string may contain email addresses and URLs, see the introduction for more details.

See also:

[propertyaboutDialog:developers]
[propertyaboutDialog:designers]
[propertyaboutDialog:artists]
[propertyaboutDialog:documenters]
[methodaboutDialog.add_credit_section]
[methodaboutDialog.add_acknowledgement_section]

Since: 1.5

setVersion

aboutDialogSetVersion Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`version`: the version
-> m ()

Sets the version for self.

The version is displayed on the main page.

If [propertyaboutDialog:release-notes-version] is not set, the version will also be displayed above the release notes on the What's New page.

Since: 1.5

setWebsite

aboutDialogSetWebsite Source #

Arguments

:: (HasCallStack, MonadIO m, IsAboutDialog a)
=> a	`self`: an about dialog
-> Text	`website`: the website URL
-> m ()

Sets the application website URL for self.

Website is displayed on the Details page, below comments, or on the main page if the Details page doesn't have any other content.

Applications can add other links below, see [methodaboutDialog.add_link].

Since: 1.5

Properties

applicationIcon

The name of the application icon.

The icon is displayed at the top of the main page.

Since: 1.5

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

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

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

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

get aboutDialog #applicationIcon

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

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

set aboutDialog [ #applicationIcon := value ]

applicationName

The name of the application.

The name is displayed at the top of the main page.

Since: 1.5

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

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

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

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

get aboutDialog #applicationName

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

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

set aboutDialog [ #applicationName := value ]

artists

The list of artists of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[propertyaboutDialog:developers]
[propertyaboutDialog:designers]
[propertyaboutDialog:documenters]
[propertyaboutDialog:translator-credits]
[methodaboutDialog.add_credit_section]
[methodaboutDialog.add_acknowledgement_section]

Since: 1.5

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

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

clear #artists

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 (Maybe [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 ]

comments

The comments about the application.

Comments will be shown on the Details page, above links.

Unlike AboutDialog:comments, this string can be long and detailed. It can also contain links and Pango markup.

Since: 1.5

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

The copyright information.

The copyright information will be displayed on the Legal page, above the application license.

methodaboutDialog.add_legal_section: can be used to add copyright information for the application dependencies or other components.

Since: 1.5

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 ]

debugInfo

The debug information.

Debug information will be shown on the Troubleshooting page. It's intended to be attached to issue reports when reporting issues against the application.

AdwAboutDialog provides a quick way to save debug information to a file. When saving, [propertyaboutDialog:debug-info-filename] would be used as the suggested filename.

Debug information cannot contain markup or links.

Since: 1.5

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

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

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

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

get aboutDialog #debugInfo

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

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

set aboutDialog [ #debugInfo := value ]

debugInfoFilename

The debug information filename.

It will be used as the suggested filename when saving debug information to a file.

See [propertyaboutDialog:debug-info].

Since: 1.5

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

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

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

Get the value of the “debug-info-filename” property. When overloading is enabled, this is equivalent to

get aboutDialog #debugInfoFilename

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

Set the value of the “debug-info-filename” property. When overloading is enabled, this is equivalent to

set aboutDialog [ #debugInfoFilename := value ]

designers

The list of designers of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[propertyaboutDialog:developers]
[propertyaboutDialog:artists]
[propertyaboutDialog:documenters]
[propertyaboutDialog:translator-credits]
[methodaboutDialog.add_credit_section]
[methodaboutDialog.add_acknowledgement_section]

Since: 1.5

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

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

clear #designers

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

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

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

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

get aboutDialog #designers

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

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

set aboutDialog [ #designers := value ]

developerName

The developer name.

The developer name is displayed on the main page, under the application name.

If the application is developed by multiple people, the developer name can be set to values like "AppName team", "AppName developers" or "The AppName project", and the individual contributors can be listed on the Credits page, with [propertyaboutDialog:developers] and related properties.

Since: 1.5

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

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

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

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

get aboutDialog #developerName

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

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

set aboutDialog [ #developerName := value ]

developers

The list of developers of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[propertyaboutDialog:designers]
[propertyaboutDialog:artists]
[propertyaboutDialog:documenters]
[propertyaboutDialog:translator-credits]
[methodaboutDialog.add_credit_section]
[methodaboutDialog.add_acknowledgement_section]

Since: 1.5

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

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

clear #developers

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

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

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

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

get aboutDialog #developers

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

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

set aboutDialog [ #developers := value ]

documenters

The list of documenters of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[propertyaboutDialog:developers]
[propertyaboutDialog:designers]
[propertyaboutDialog:artists]
[propertyaboutDialog:translator-credits]
[methodaboutDialog.add_credit_section]
[methodaboutDialog.add_acknowledgement_section]

Since: 1.5

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

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

clear #documenters

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 (Maybe [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 ]

issueUrl

The URL for the application's issue tracker.

The issue tracker link is displayed on the main page.

Since: 1.5

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

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

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

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

get aboutDialog #issueUrl

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

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

set aboutDialog [ #issueUrl := value ]

license

The license text.

This can be used to set a custom text for the license if it can't be set via [propertyaboutDialog:license-type].

When set, [propertyaboutDialog:license-type] will be set to GTK_LICENSE_CUSTOM.

The license text will be displayed on the Legal page, below the copyright information.

License text can contain Pango markup and links.

methodaboutDialog.add_legal_section: can be used to add license information for the application dependencies or other components.

Since: 1.5

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

Allows to set the application's license froma list of known licenses.

If the application's license is not in the list, [propertyaboutDialog:license] can be used instead. The license type will be automatically set to GTK_LICENSE_CUSTOM in that case.

If set to GTK_LICENSE_UNKNOWN, no information will be displayed.

If the license type is different from GTK_LICENSE_CUSTOM. [propertyaboutDialog:license] will be cleared out.

The license description will be displayed on the Legal page, below the copyright information.

methodaboutDialog.add_legal_section: can be used to add license information for the application dependencies or other components.

Since: 1.5

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 ]

releaseNotes

The release notes of the application.

Release notes are displayed on the the What's New page.

Release notes are formatted the same way as AppStream descriptions.

The supported formatting options are:

Paragraph ()
Ordered list (<ol>), with list items (<li>)
Unordered list (<ul>), with list items (<li>)

Within paragraphs and list items, emphasis () and inline code (<code>) text styles are supported. The emphasis is rendered in italic, while inline code is shown in a monospaced font.

Any text outside paragraphs or list items is ignored.

Nested lists are not supported.

AdwAboutDialog displays the version above the release notes. If set, the [propertyaboutDialog:release-notes-version] of the property will be used as the version; otherwise, [propertyaboutDialog:version] is used.

Since: 1.5

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

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

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

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

get aboutDialog #releaseNotes

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

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

set aboutDialog [ #releaseNotes := value ]

releaseNotesVersion

The version described by the application's release notes.

The release notes version is displayed on the What's New page, above the release notes.

If not set, [propertyaboutDialog:version] will be used instead.

For example, an application with the current version 2.0.2 might want to keep the release notes from 2.0.0, and set the release notes version accordingly.

See [propertyaboutDialog:release-notes].

Since: 1.5

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

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

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

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

get aboutDialog #releaseNotesVersion

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

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

set aboutDialog [ #releaseNotesVersion := value ]

supportUrl

The URL of the application's support page.

The support page link is displayed on the main page.

Since: 1.5

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

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

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

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

get aboutDialog #supportUrl

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

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

set aboutDialog [ #supportUrl := value ]

translatorCredits

The translator credits string.

It will be displayed on the Credits page.

This string should be "translator-credits" or "translator_credits" and should be marked as translatable.

The string may contain email addresses and URLs, see the introduction for more details.

See also:

[propertyaboutDialog:developers]
[propertyaboutDialog:designers]
[propertyaboutDialog:artists]
[propertyaboutDialog:documenters]
[methodaboutDialog.add_credit_section]
[methodaboutDialog.add_acknowledgement_section]

Since: 1.5

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

The version is displayed on the main page.

If [propertyaboutDialog:release-notes-version] is not set, the version will also be displayed above the release notes on the What's New page.

Since: 1.5

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 of the application's website.

Website is displayed on the Details page, below comments, or on the main page if the Details page doesn't have any other content.

Applications can add other links below, see [methodaboutDialog.add_link].

Since: 1.5

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 ]

Signals

activateLink

type AboutDialogActivateLinkCallback Source #

Arguments

= Text	`uri`: the URI to activate
-> IO Bool	Returns: `TRUE` if the link has been activated

Emitted when a URL is activated.

Applications may connect to it to override the default behavior, which is to call showUri.

Since: 1.5

afterAboutDialogActivateLink :: (IsAboutDialog a, MonadIO m) => a -> ((?self :: 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

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

Main page

What's New

Details

Troubleshooting

Credits and Acknowledgements

Legal

Constructing

c code

CSS nodes

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

addAcknowledgementSection

addCreditSection

addLegalSection

c code

addLink

getApplicationIcon

getApplicationName

getArtists

getComments

getCopyright

getDebugInfo

getDebugInfoFilename

getDesigners

getDeveloperName

getDevelopers

getDocumenters

getIssueUrl

getLicense

getLicenseType

getReleaseNotes

getReleaseNotesVersion

getSupportUrl

getTranslatorCredits

getVersion

getWebsite

new

newFromAppdata

setApplicationIcon

setApplicationName

setArtists

setComments

setCopyright

setDebugInfo

setDebugInfoFilename

setDesigners

setDeveloperName

setDevelopers

setDocumenters

setIssueUrl

setLicense

setLicenseType

setReleaseNotes

setReleaseNotesVersion

setSupportUrl

setTranslatorCredits

setVersion

setWebsite

Properties

applicationIcon

applicationName

artists

comments

copyright

debugInfo

debugInfoFilename

designers

developerName

developers

documenters

issueUrl

license

licenseType

releaseNotes