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 |
- Exported types
- Methods
- addAcknowledgementSection
- addCreditSection
- addLegalSection
- addLink
- getApplicationIcon
- getApplicationName
- getArtists
- getComments
- getCopyright
- getDebugInfo
- getDebugInfoFilename
- getDesigners
- getDeveloperName
- getDevelopers
- getDocumenters
- getIssueUrl
- getLicense
- getLicenseType
- getReleaseNotes
- getReleaseNotesVersion
- getSupportUrl
- getTranslatorCredits
- getVersion
- getWebsite
- new
- setApplicationIcon
- setApplicationName
- setArtists
- setComments
- setCopyright
- setDebugInfo
- setDebugInfoFilename
- setDesigners
- setDeveloperName
- setDevelopers
- setDocumenters
- setIssueUrl
- setLicense
- setLicenseType
- setReleaseNotes
- setReleaseNotesVersion
- setSupportUrl
- setTranslatorCredits
- setVersion
- setWebsite
- Properties
- Signals
A window showing information about the application.
<picture> <source srcset="about-window-dark.png" media="(prefers-color-scheme: dark)"> <img src="about-window.png" alt="about-window"> </picture>
An about window is typically opened when the user activates the About …
item in the application's primary menu. All parts of the window are optional.
Main page
AdwAboutWindow
prominently displays the application's icon, name, developer
name and version. They can be set with the [propertyaboutWindow
:application-icon],
[propertyaboutWindow
:application-name],
[propertyaboutWindow
:developer-name] and [propertyaboutWindow
:version]
respectively.
What's New
AdwAboutWindow
provides a way for applications to display their release
notes, set with the [propertyaboutWindow
:release-notes] property.
Release notes are formatted the same way as AppStream descriptions.
The supported formatting options are:
- Paragraph (
<p>
) - Ordered list (
<ol>
), with list items (<li>
) - Unordered list (
<ul>
), with list items (<li>
)
Within paragraphs and list items, emphasis (<em>
) 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 [propertyaboutWindow
:version]. Use
[propertyaboutWindow
:release-notes-version] to override it.
Details
The Details page displays the application comments and links.
The comments can be set with the [propertyaboutWindow
: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 [propertyaboutWindow
:website].
To add extra links below the website, use [methodaboutWindow
.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
AdwAboutWindow
displays the following two links on the main page:
- Support Questions, set with the [property
aboutWindow
:support-url] property, - Report an Issue, set with the [property
aboutWindow
:issue-url] property.
Additionally, applications can provide debugging information. It will be
shown separately on the Troubleshooting page. Use the
[propertyaboutWindow
: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.
AdwAboutWindow
provides a quick way to save debug information to a file.
When saving, [propertyaboutWindow
: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 [property
aboutWindow
:developers] property, - Designers, set with the [property
aboutWindow
:designers] property, - Artists, set with the [property
aboutWindow
:artists] property, - Documenters, set with the [property
aboutWindow
:documenters] property, - Translators, set with the [property
aboutWindow
: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 [methodaboutWindow
.add_credit_section] to add them.
The Acknowledgements page can be used to acknowledge additional people and
organizations for their non-development contributions. Use
[methodaboutWindow
.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
:
<picture> <source srcset="about-window-credits-dark.png" media="(prefers-color-scheme: dark)"> <img src="about-window-credits.png" alt="about-window-credits"> </picture>
Legal
The Legal page displays the copyright and licensing information for the application and other modules.
The copyright string is set with the [propertyaboutWindow
:copyright]
property and should be a short string of one or two lines, for example:
© 2022 Example
.
Licensing information can be quickly set from a list of known licenses with
the [propertyaboutWindow
:license-type] property. If the application's
license is not in the list, [propertyaboutWindow
:license] can be used
instead.
To add information about other modules, such as application dependencies or
data, use [methodaboutWindow
.add_legal_section].
Constructing
To make constructing an AdwAboutWindow
as convenient as possible, you can
use the function [funcshowAboutWindow
] which constructs and shows a
window.
c code
static void show_about (GtkApplication *app) { const char *developers[] = { "Angela Avery", NULL }; const char *designers[] = { "GNOME Design Team", NULL }; adw_show_about_window (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
AdwAboutWindow
has a main CSS node with the name window
and the
style class .about
.
Since: 1.2
Synopsis
- newtype AboutWindow = AboutWindow (ManagedPtr AboutWindow)
- class (GObject o, IsDescendantOf AboutWindow o) => IsAboutWindow o
- toAboutWindow :: (MonadIO m, IsAboutWindow o) => o -> m AboutWindow
- aboutWindowAddAcknowledgementSection :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Maybe Text -> [Text] -> m ()
- aboutWindowAddCreditSection :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Maybe Text -> [Text] -> m ()
- aboutWindowAddLegalSection :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> Maybe Text -> License -> Maybe Text -> m ()
- aboutWindowAddLink :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> Text -> m ()
- aboutWindowGetApplicationIcon :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowGetApplicationName :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowGetArtists :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m (Maybe [Text])
- aboutWindowGetComments :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowGetCopyright :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowGetDebugInfo :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowGetDebugInfoFilename :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowGetDesigners :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m (Maybe [Text])
- aboutWindowGetDeveloperName :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowGetDevelopers :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m (Maybe [Text])
- aboutWindowGetDocumenters :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m (Maybe [Text])
- aboutWindowGetIssueUrl :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowGetLicense :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowGetLicenseType :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m License
- aboutWindowGetReleaseNotes :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowGetReleaseNotesVersion :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowGetSupportUrl :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowGetTranslatorCredits :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowGetVersion :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowGetWebsite :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> m Text
- aboutWindowNew :: (HasCallStack, MonadIO m) => m AboutWindow
- aboutWindowSetApplicationIcon :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- aboutWindowSetApplicationName :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- aboutWindowSetArtists :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Maybe [Text] -> m ()
- aboutWindowSetComments :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- aboutWindowSetCopyright :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- aboutWindowSetDebugInfo :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- aboutWindowSetDebugInfoFilename :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- aboutWindowSetDesigners :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Maybe [Text] -> m ()
- aboutWindowSetDeveloperName :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- aboutWindowSetDevelopers :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Maybe [Text] -> m ()
- aboutWindowSetDocumenters :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Maybe [Text] -> m ()
- aboutWindowSetIssueUrl :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- aboutWindowSetLicense :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- aboutWindowSetLicenseType :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> License -> m ()
- aboutWindowSetReleaseNotes :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- aboutWindowSetReleaseNotesVersion :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- aboutWindowSetSupportUrl :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- aboutWindowSetTranslatorCredits :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- aboutWindowSetVersion :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- aboutWindowSetWebsite :: (HasCallStack, MonadIO m, IsAboutWindow a) => a -> Text -> m ()
- constructAboutWindowApplicationIcon :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowApplicationIcon :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowApplicationIcon :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- constructAboutWindowApplicationName :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowApplicationName :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowApplicationName :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- clearAboutWindowArtists :: (MonadIO m, IsAboutWindow o) => o -> m ()
- constructAboutWindowArtists :: (IsAboutWindow o, MonadIO m) => [Text] -> m (GValueConstruct o)
- getAboutWindowArtists :: (MonadIO m, IsAboutWindow o) => o -> m (Maybe [Text])
- setAboutWindowArtists :: (MonadIO m, IsAboutWindow o) => o -> [Text] -> m ()
- constructAboutWindowComments :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowComments :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowComments :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- constructAboutWindowCopyright :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowCopyright :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowCopyright :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- constructAboutWindowDebugInfo :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowDebugInfo :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowDebugInfo :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- constructAboutWindowDebugInfoFilename :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowDebugInfoFilename :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowDebugInfoFilename :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- clearAboutWindowDesigners :: (MonadIO m, IsAboutWindow o) => o -> m ()
- constructAboutWindowDesigners :: (IsAboutWindow o, MonadIO m) => [Text] -> m (GValueConstruct o)
- getAboutWindowDesigners :: (MonadIO m, IsAboutWindow o) => o -> m (Maybe [Text])
- setAboutWindowDesigners :: (MonadIO m, IsAboutWindow o) => o -> [Text] -> m ()
- constructAboutWindowDeveloperName :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowDeveloperName :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowDeveloperName :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- clearAboutWindowDevelopers :: (MonadIO m, IsAboutWindow o) => o -> m ()
- constructAboutWindowDevelopers :: (IsAboutWindow o, MonadIO m) => [Text] -> m (GValueConstruct o)
- getAboutWindowDevelopers :: (MonadIO m, IsAboutWindow o) => o -> m (Maybe [Text])
- setAboutWindowDevelopers :: (MonadIO m, IsAboutWindow o) => o -> [Text] -> m ()
- clearAboutWindowDocumenters :: (MonadIO m, IsAboutWindow o) => o -> m ()
- constructAboutWindowDocumenters :: (IsAboutWindow o, MonadIO m) => [Text] -> m (GValueConstruct o)
- getAboutWindowDocumenters :: (MonadIO m, IsAboutWindow o) => o -> m (Maybe [Text])
- setAboutWindowDocumenters :: (MonadIO m, IsAboutWindow o) => o -> [Text] -> m ()
- constructAboutWindowIssueUrl :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowIssueUrl :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowIssueUrl :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- constructAboutWindowLicense :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowLicense :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowLicense :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- constructAboutWindowLicenseType :: (IsAboutWindow o, MonadIO m) => License -> m (GValueConstruct o)
- getAboutWindowLicenseType :: (MonadIO m, IsAboutWindow o) => o -> m License
- setAboutWindowLicenseType :: (MonadIO m, IsAboutWindow o) => o -> License -> m ()
- constructAboutWindowReleaseNotes :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowReleaseNotes :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowReleaseNotes :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- constructAboutWindowReleaseNotesVersion :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowReleaseNotesVersion :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowReleaseNotesVersion :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- constructAboutWindowSupportUrl :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowSupportUrl :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowSupportUrl :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- constructAboutWindowTranslatorCredits :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowTranslatorCredits :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowTranslatorCredits :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- constructAboutWindowVersion :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowVersion :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowVersion :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- constructAboutWindowWebsite :: (IsAboutWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getAboutWindowWebsite :: (MonadIO m, IsAboutWindow o) => o -> m Text
- setAboutWindowWebsite :: (MonadIO m, IsAboutWindow o) => o -> Text -> m ()
- type AboutWindowActivateLinkCallback = Text -> IO Bool
- afterAboutWindowActivateLink :: (IsAboutWindow a, MonadIO m) => a -> ((?self :: a) => AboutWindowActivateLinkCallback) -> m SignalHandlerId
- onAboutWindowActivateLink :: (IsAboutWindow a, MonadIO m) => a -> ((?self :: a) => AboutWindowActivateLinkCallback) -> m SignalHandlerId
Exported types
newtype AboutWindow Source #
Memory-managed wrapper type.
AboutWindow (ManagedPtr AboutWindow) |
Instances
Eq AboutWindow Source # | |
Defined in GI.Adw.Objects.AboutWindow (==) :: AboutWindow -> AboutWindow -> Bool # (/=) :: AboutWindow -> AboutWindow -> Bool # | |
GObject AboutWindow Source # | |
Defined in GI.Adw.Objects.AboutWindow | |
ManagedPtrNewtype AboutWindow Source # | |
Defined in GI.Adw.Objects.AboutWindow toManagedPtr :: AboutWindow -> ManagedPtr AboutWindow | |
TypedObject AboutWindow Source # | |
Defined in GI.Adw.Objects.AboutWindow | |
HasParentTypes AboutWindow Source # | |
Defined in GI.Adw.Objects.AboutWindow | |
IsGValue (Maybe AboutWindow) Source # | Convert |
Defined in GI.Adw.Objects.AboutWindow gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe AboutWindow -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe AboutWindow) | |
type ParentTypes AboutWindow Source # | |
Defined in GI.Adw.Objects.AboutWindow type ParentTypes AboutWindow = '[Window, Window, Widget, Object, Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager] |
class (GObject o, IsDescendantOf AboutWindow o) => IsAboutWindow o Source #
Type class for types which can be safely cast to AboutWindow
, for instance with toAboutWindow
.
Instances
(GObject o, IsDescendantOf AboutWindow o) => IsAboutWindow o Source # | |
Defined in GI.Adw.Objects.AboutWindow |
toAboutWindow :: (MonadIO m, IsAboutWindow o) => o -> m AboutWindow Source #
Cast to AboutWindow
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Click to display all available methods, including inherited ones
Methods
actionSetEnabled, activate, activateAction, activateDefault, addAcknowledgementSection, addController, addCreditSection, addCssClass, addLegalSection, addLink, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, close, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, destroy, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, fullscreen, fullscreenOnMonitor, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasGroup, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isActive, isAncestor, isDrawable, isFloating, isFocus, isFullscreen, isMaximized, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, maximize, measure, minimize, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, present, presentWithTime, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unfullscreen, unmap, unmaximize, unminimize, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccessibleParent, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getApplication, getApplicationIcon, getApplicationName, getArtists, getAtContext, getBounds, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getColor, getComments, getContent, getCopyright, getCssClasses, getCssName, getCursor, getData, getDebugInfo, getDebugInfoFilename, getDecorated, getDefaultSize, getDefaultWidget, getDeletable, getDesigners, getDestroyWithParent, getDeveloperName, getDevelopers, getDirection, getDisplay, getDocumenters, getFirstAccessibleChild, getFirstChild, getFocus, getFocusChild, getFocusOnClick, getFocusVisible, getFocusable, getFontMap, getFontOptions, getFrameClock, getGroup, getHalign, getHandleMenubarAccel, getHasTooltip, getHeight, getHexpand, getHexpandSet, getHideOnClose, getIconName, getIssueUrl, getLastChild, getLayoutManager, getLicense, getLicenseType, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMnemonicsVisible, getModal, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPlatformState, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getReleaseNotes, getReleaseNotesVersion, getRenderer, getRequestMode, getResizable, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getSupportUrl, getSurface, getSurfaceTransform, getTemplateChild, getTitle, getTitlebar, getTooltipMarkup, getTooltipText, getTransientFor, getTranslatorCredits, getValign, getVersion, getVexpand, getVexpandSet, getVisible, getWebsite, getWidth.
Setters
setAccessibleParent, setApplication, setApplicationIcon, setApplicationName, setArtists, setCanFocus, setCanTarget, setChild, setChildVisible, setComments, setContent, setCopyright, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDebugInfo, setDebugInfoFilename, setDecorated, setDefaultSize, setDefaultWidget, setDeletable, setDesigners, setDestroyWithParent, setDeveloperName, setDevelopers, setDirection, setDisplay, setDocumenters, setFocus, setFocusChild, setFocusOnClick, setFocusVisible, setFocusable, setFontMap, setFontOptions, setHalign, setHandleMenubarAccel, setHasTooltip, setHexpand, setHexpandSet, setHideOnClose, setIconName, setIssueUrl, setLayoutManager, setLicense, setLicenseType, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setMnemonicsVisible, setModal, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setReleaseNotes, setReleaseNotesVersion, setResizable, setSensitive, setSizeRequest, setStartupId, setStateFlags, setSupportUrl, setTitle, setTitlebar, setTooltipMarkup, setTooltipText, setTransientFor, setTranslatorCredits, setValign, setVersion, setVexpand, setVexpandSet, setVisible, setWebsite.
addAcknowledgementSection
aboutWindowAddAcknowledgementSection Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Maybe Text |
|
-> [Text] |
|
-> 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:
- [property
aboutWindow
:developers] - [property
aboutWindow
:designers] - [property
aboutWindow
:artists] - [property
aboutWindow
:documenters] - [property
aboutWindow
:translator-credits] - [method
aboutWindow
.add_credit_section]
Since: 1.2
addCreditSection
aboutWindowAddCreditSection Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Maybe Text |
|
-> [Text] |
|
-> 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:
- [property
aboutWindow
:developers] - [property
aboutWindow
:designers] - [property
aboutWindow
:artists] - [property
aboutWindow
:documenters] - [property
aboutWindow
:translator-credits] - [method
aboutWindow
.add_acknowledgement_section]
Since: 1.2
addLegalSection
aboutWindowAddLegalSection Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> Maybe Text |
|
-> License |
|
-> Maybe Text |
|
-> 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 [propertyaboutWindow
:copyright],
[propertyaboutWindow
:license-type] and [propertyaboutWindow
: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_window_add_legal_section (ADW_ABOUT_WINDOW (about), _("Copyright and a known license"), "© 2022 Example", GTK_LICENSE_LGPL_2_1, NULL); adw_about_window_add_legal_section (ADW_ABOUT_WINDOW (about), _("Copyright and custom license"), "© 2022 Example", GTK_LICENSE_CUSTOM, "Custom license text"); adw_about_window_add_legal_section (ADW_ABOUT_WINDOW (about), _("Copyright only"), "© 2022 Example", GTK_LICENSE_UNKNOWN, NULL); adw_about_window_add_legal_section (ADW_ABOUT_WINDOW (about), _("Custom license only"), NULL, GTK_LICENSE_CUSTOM, "Something completely custom here.");
Since: 1.2
addLink
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> Text |
|
-> 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 [propertyaboutWindow
:website].
Since: 1.2
getApplicationIcon
aboutWindowGetApplicationIcon Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: the application icon name |
Gets the name of the application icon for self
.
Since: 1.2
getApplicationName
aboutWindowGetApplicationName Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: the application name |
Gets the application name for self
.
Since: 1.2
getArtists
aboutWindowGetArtists Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m (Maybe [Text]) | Returns: The list of artists |
Gets the list of artists of the application.
Since: 1.2
getComments
aboutWindowGetComments Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: the comments |
Gets the comments about the application.
Since: 1.2
getCopyright
aboutWindowGetCopyright Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: the copyright information |
Gets the copyright information for self
.
Since: 1.2
getDebugInfo
aboutWindowGetDebugInfo Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: the debug information |
Gets the debug information for self
.
Since: 1.2
getDebugInfoFilename
aboutWindowGetDebugInfoFilename Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: the debug information filename |
Gets the debug information filename for self
.
Since: 1.2
getDesigners
aboutWindowGetDesigners Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m (Maybe [Text]) | Returns: The list of designers |
Gets the list of designers of the application.
Since: 1.2
getDeveloperName
aboutWindowGetDeveloperName Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: the developer_name |
Gets the developer name for self
.
Since: 1.2
getDevelopers
aboutWindowGetDevelopers Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m (Maybe [Text]) | Returns: The list of developers |
Gets the list of developers of the application.
Since: 1.2
getDocumenters
aboutWindowGetDocumenters Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m (Maybe [Text]) | Returns: The list of documenters |
Gets the list of documenters of the application.
Since: 1.2
getIssueUrl
aboutWindowGetIssueUrl Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: the issue tracker URL |
Gets the issue tracker URL for self
.
Since: 1.2
getLicense
aboutWindowGetLicense Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: the license |
Gets the license for self
.
Since: 1.2
getLicenseType
aboutWindowGetLicenseType Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m License | Returns: the license type |
Gets the license type for self
.
Since: 1.2
getReleaseNotes
aboutWindowGetReleaseNotes Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: the release notes |
Gets the release notes for self
.
Since: 1.2
getReleaseNotesVersion
aboutWindowGetReleaseNotesVersion Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: the release notes version |
Gets the version described by the application's release notes.
Since: 1.2
getSupportUrl
aboutWindowGetSupportUrl Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: the support page URL |
Gets the URL of the support page for self
.
Since: 1.2
getTranslatorCredits
aboutWindowGetTranslatorCredits Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: The translator credits string |
Gets the translator credits string.
Since: 1.2
getVersion
aboutWindowGetVersion Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: the version |
Gets the version for self
.
Since: 1.2
getWebsite
aboutWindowGetWebsite Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> m Text | Returns: the website URL |
Gets the application website URL for self
.
Since: 1.2
new
:: (HasCallStack, MonadIO m) | |
=> m AboutWindow | Returns: the newly created |
Creates a new AdwAboutWindow
.
Since: 1.2
setApplicationIcon
aboutWindowSetApplicationIcon Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the name of the application icon for self
.
The icon is displayed at the top of the main page.
Since: 1.2
setApplicationName
aboutWindowSetApplicationName Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the application name for self
.
The name is displayed at the top of the main page.
Since: 1.2
setArtists
aboutWindowSetArtists Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Maybe [Text] |
|
-> 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:
- [property
aboutWindow
:developers] - [property
aboutWindow
:designers] - [property
aboutWindow
:documenters] - [property
aboutWindow
:translator-credits] - [method
aboutWindow
.add_credit_section] - [method
aboutWindow
.add_acknowledgement_section]
Since: 1.2
setComments
aboutWindowSetComments Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> 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.2
setCopyright
aboutWindowSetCopyright Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the copyright information for self
.
This should be a short string of one or two lines, for example:
© 2022 Example
.
The copyright information will be displayed on the Legal page, before the application license.
- method
aboutWindow
.add_legal_section - can be used to add copyright information for the application dependencies or other components.
Since: 1.2
setDebugInfo
aboutWindowSetDebugInfo Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> 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.
AdwAboutWindow
provides a quick way to save debug information to a file.
When saving, [propertyaboutWindow
:debug-info-filename] would be used as
the suggested filename.
Debug information cannot contain markup or links.
Since: 1.2
setDebugInfoFilename
aboutWindowSetDebugInfoFilename Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the debug information filename for self
.
It will be used as the suggested filename when saving debug information to a file.
See [propertyaboutWindow
:debug-info].
Since: 1.2
setDesigners
aboutWindowSetDesigners Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Maybe [Text] |
|
-> 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:
- [property
aboutWindow
:developers] - [property
aboutWindow
:artists] - [property
aboutWindow
:documenters] - [property
aboutWindow
:translator-credits] - [method
aboutWindow
.add_credit_section] - [method
aboutWindow
.add_acknowledgement_section]
Since: 1.2
setDeveloperName
aboutWindowSetDeveloperName Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> 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 [propertyaboutWindow
:developers] and related properties.
Since: 1.2
setDevelopers
aboutWindowSetDevelopers Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Maybe [Text] |
|
-> 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:
- [property
aboutWindow
:designers] - [property
aboutWindow
:artists] - [property
aboutWindow
:documenters] - [property
aboutWindow
:translator-credits] - [method
aboutWindow
.add_credit_section] - [method
aboutWindow
.add_acknowledgement_section]
Since: 1.2
setDocumenters
aboutWindowSetDocumenters Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Maybe [Text] |
|
-> 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:
- [property
aboutWindow
:developers] - [property
aboutWindow
:designers] - [property
aboutWindow
:artists] - [property
aboutWindow
:translator-credits] - [method
aboutWindow
.add_credit_section] - [method
aboutWindow
.add_acknowledgement_section]
Since: 1.2
setIssueUrl
aboutWindowSetIssueUrl Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the issue tracker URL for self
.
The issue tracker link is displayed on the main page.
Since: 1.2
setLicense
aboutWindowSetLicense Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> 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
[propertyaboutWindow
:license-type].
When set, [propertyaboutWindow
: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.
- method
aboutWindow
.add_legal_section - can be used to add license information for the application dependencies or other components.
Since: 1.2
setLicenseType
aboutWindowSetLicenseType Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> License |
|
-> m () |
Sets the license for self
from a list of known licenses.
If the application's license is not in the list,
[propertyaboutWindow
: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
.
[propertyaboutWindow
:license] will be cleared out.
The license description will be displayed on the Legal page, below the copyright information.
- method
aboutWindow
.add_legal_section - can be used to add license information for the application dependencies or other components.
Since: 1.2
setReleaseNotes
aboutWindowSetReleaseNotes Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> 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 (
<p>
) - Ordered list (
<ol>
), with list items (<li>
) - Unordered list (
<ul>
), with list items (<li>
)
Within paragraphs and list items, emphasis (<em>
) 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.
AdwAboutWindow
displays the version above the release notes. If set, the
[propertyaboutWindow
:release-notes-version] of the property will be used
as the version; otherwise, [propertyaboutWindow
:version] is used.
Since: 1.2
setReleaseNotesVersion
aboutWindowSetReleaseNotesVersion Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> 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, [propertyaboutWindow
: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 [propertyaboutWindow
:release-notes].
Since: 1.2
setSupportUrl
aboutWindowSetSupportUrl Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the URL of the support page for self
.
The support page link is displayed on the main page.
Since: 1.2
setTranslatorCredits
aboutWindowSetTranslatorCredits Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> 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:
- [property
aboutWindow
:developers] - [property
aboutWindow
:designers] - [property
aboutWindow
:artists] - [property
aboutWindow
:documenters] - [method
aboutWindow
.add_credit_section] - [method
aboutWindow
.add_acknowledgement_section]
Since: 1.2
setVersion
aboutWindowSetVersion Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the version for self
.
The version is displayed on the main page.
If [propertyaboutWindow
:release-notes-version] is not set, the version will
also be displayed above the release notes on the What's New page.
Since: 1.2
setWebsite
aboutWindowSetWebsite Source #
:: (HasCallStack, MonadIO m, IsAboutWindow a) | |
=> a |
|
-> Text |
|
-> 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 [methodaboutWindow
.add_link].
Since: 1.2
Properties
applicationIcon
The name of the application icon.
The icon is displayed at the top of the main page.
Since: 1.2
constructAboutWindowApplicationIcon :: (IsAboutWindow 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
.
getAboutWindowApplicationIcon :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “application-icon
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #applicationIcon
setAboutWindowApplicationIcon :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “application-icon
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #applicationIcon:=
value ]
applicationName
The name of the application.
The name is displayed at the top of the main page.
Since: 1.2
constructAboutWindowApplicationName :: (IsAboutWindow 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
.
getAboutWindowApplicationName :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “application-name
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #applicationName
setAboutWindowApplicationName :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “application-name
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #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:
- [property
aboutWindow
:developers] - [property
aboutWindow
:designers] - [property
aboutWindow
:documenters] - [property
aboutWindow
:translator-credits] - [method
aboutWindow
.add_credit_section] - [method
aboutWindow
.add_acknowledgement_section]
Since: 1.2
clearAboutWindowArtists :: (MonadIO m, IsAboutWindow o) => o -> m () Source #
Set the value of the “artists
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#artists
constructAboutWindowArtists :: (IsAboutWindow 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
.
getAboutWindowArtists :: (MonadIO m, IsAboutWindow o) => o -> m (Maybe [Text]) Source #
Get the value of the “artists
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #artists
setAboutWindowArtists :: (MonadIO m, IsAboutWindow o) => o -> [Text] -> m () Source #
Set the value of the “artists
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #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.2
constructAboutWindowComments :: (IsAboutWindow 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
.
getAboutWindowComments :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “comments
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #comments
setAboutWindowComments :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “comments
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #comments:=
value ]
copyright
The copyright information.
This should be a short string of one or two lines, for example:
© 2022 Example
.
The copyright information will be displayed on the Legal page, above the application license.
- method
aboutWindow
.add_legal_section - can be used to add copyright information for the application dependencies or other components.
Since: 1.2
constructAboutWindowCopyright :: (IsAboutWindow 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
.
getAboutWindowCopyright :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “copyright
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #copyright
setAboutWindowCopyright :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “copyright
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #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.
AdwAboutWindow
provides a quick way to save debug information to a file.
When saving, [propertyaboutWindow
:debug-info-filename] would be used as
the suggested filename.
Debug information cannot contain markup or links.
Since: 1.2
constructAboutWindowDebugInfo :: (IsAboutWindow 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
.
getAboutWindowDebugInfo :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “debug-info
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #debugInfo
setAboutWindowDebugInfo :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “debug-info
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #debugInfo:=
value ]
debugInfoFilename
The debug information filename.
It will be used as the suggested filename when saving debug information to a file.
See [propertyaboutWindow
:debug-info].
Since: 1.2
constructAboutWindowDebugInfoFilename :: (IsAboutWindow 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
.
getAboutWindowDebugInfoFilename :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “debug-info-filename
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #debugInfoFilename
setAboutWindowDebugInfoFilename :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “debug-info-filename
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #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:
- [property
aboutWindow
:developers] - [property
aboutWindow
:artists] - [property
aboutWindow
:documenters] - [property
aboutWindow
:translator-credits] - [method
aboutWindow
.add_credit_section] - [method
aboutWindow
.add_acknowledgement_section]
Since: 1.2
clearAboutWindowDesigners :: (MonadIO m, IsAboutWindow o) => o -> m () Source #
Set the value of the “designers
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#designers
constructAboutWindowDesigners :: (IsAboutWindow 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
.
getAboutWindowDesigners :: (MonadIO m, IsAboutWindow o) => o -> m (Maybe [Text]) Source #
Get the value of the “designers
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #designers
setAboutWindowDesigners :: (MonadIO m, IsAboutWindow o) => o -> [Text] -> m () Source #
Set the value of the “designers
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #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 [propertyaboutWindow
:developers] and related
properties.
Since: 1.2
constructAboutWindowDeveloperName :: (IsAboutWindow 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
.
getAboutWindowDeveloperName :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “developer-name
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #developerName
setAboutWindowDeveloperName :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “developer-name
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #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:
- [property
aboutWindow
:designers] - [property
aboutWindow
:artists] - [property
aboutWindow
:documenters] - [property
aboutWindow
:translator-credits] - [method
aboutWindow
.add_credit_section] - [method
aboutWindow
.add_acknowledgement_section]
Since: 1.2
clearAboutWindowDevelopers :: (MonadIO m, IsAboutWindow o) => o -> m () Source #
Set the value of the “developers
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#developers
constructAboutWindowDevelopers :: (IsAboutWindow 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
.
getAboutWindowDevelopers :: (MonadIO m, IsAboutWindow o) => o -> m (Maybe [Text]) Source #
Get the value of the “developers
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #developers
setAboutWindowDevelopers :: (MonadIO m, IsAboutWindow o) => o -> [Text] -> m () Source #
Set the value of the “developers
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #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:
- [property
aboutWindow
:developers] - [property
aboutWindow
:designers] - [property
aboutWindow
:artists] - [property
aboutWindow
:translator-credits] - [method
aboutWindow
.add_credit_section] - [method
aboutWindow
.add_acknowledgement_section]
Since: 1.2
clearAboutWindowDocumenters :: (MonadIO m, IsAboutWindow o) => o -> m () Source #
Set the value of the “documenters
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#documenters
constructAboutWindowDocumenters :: (IsAboutWindow 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
.
getAboutWindowDocumenters :: (MonadIO m, IsAboutWindow o) => o -> m (Maybe [Text]) Source #
Get the value of the “documenters
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #documenters
setAboutWindowDocumenters :: (MonadIO m, IsAboutWindow o) => o -> [Text] -> m () Source #
Set the value of the “documenters
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #documenters:=
value ]
issueUrl
The URL for the application's issue tracker.
The issue tracker link is displayed on the main page.
Since: 1.2
constructAboutWindowIssueUrl :: (IsAboutWindow 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
.
getAboutWindowIssueUrl :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “issue-url
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #issueUrl
setAboutWindowIssueUrl :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “issue-url
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #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 [propertyaboutWindow
:license-type].
When set, [propertyaboutWindow
: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.
- method
aboutWindow
.add_legal_section - can be used to add license information for the application dependencies or other components.
Since: 1.2
constructAboutWindowLicense :: (IsAboutWindow 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
.
getAboutWindowLicense :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “license
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #license
setAboutWindowLicense :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “license
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #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,
[propertyaboutWindow
: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
.
[propertyaboutWindow
:license] will be cleared out.
The license description will be displayed on the Legal page, below the copyright information.
- method
aboutWindow
.add_legal_section - can be used to add license information for the application dependencies or other components.
Since: 1.2
constructAboutWindowLicenseType :: (IsAboutWindow 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
.
getAboutWindowLicenseType :: (MonadIO m, IsAboutWindow o) => o -> m License Source #
Get the value of the “license-type
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #licenseType
setAboutWindowLicenseType :: (MonadIO m, IsAboutWindow o) => o -> License -> m () Source #
Set the value of the “license-type
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #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 (
<p>
) - Ordered list (
<ol>
), with list items (<li>
) - Unordered list (
<ul>
), with list items (<li>
)
Within paragraphs and list items, emphasis (<em>
) 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.
AdwAboutWindow
displays the version above the release notes. If set, the
[propertyaboutWindow
:release-notes-version] of the property will be used
as the version; otherwise, [propertyaboutWindow
:version] is used.
Since: 1.2
constructAboutWindowReleaseNotes :: (IsAboutWindow 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
.
getAboutWindowReleaseNotes :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “release-notes
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #releaseNotes
setAboutWindowReleaseNotes :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “release-notes
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #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, [propertyaboutWindow
: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 [propertyaboutWindow
:release-notes].
Since: 1.2
constructAboutWindowReleaseNotesVersion :: (IsAboutWindow 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
.
getAboutWindowReleaseNotesVersion :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “release-notes-version
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #releaseNotesVersion
setAboutWindowReleaseNotesVersion :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “release-notes-version
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #releaseNotesVersion:=
value ]
supportUrl
The URL of the application's support page.
The support page link is displayed on the main page.
Since: 1.2
constructAboutWindowSupportUrl :: (IsAboutWindow 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
.
getAboutWindowSupportUrl :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “support-url
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #supportUrl
setAboutWindowSupportUrl :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “support-url
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #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:
- [property
aboutWindow
:developers] - [property
aboutWindow
:designers] - [property
aboutWindow
:artists] - [property
aboutWindow
:documenters] - [method
aboutWindow
.add_credit_section] - [method
aboutWindow
.add_acknowledgement_section]
Since: 1.2
constructAboutWindowTranslatorCredits :: (IsAboutWindow 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
.
getAboutWindowTranslatorCredits :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “translator-credits
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #translatorCredits
setAboutWindowTranslatorCredits :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “translator-credits
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #translatorCredits:=
value ]
version
The version of the application.
The version is displayed on the main page.
If [propertyaboutWindow
:release-notes-version] is not set, the version
will also be displayed above the release notes on the What's New page.
Since: 1.2
constructAboutWindowVersion :: (IsAboutWindow 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
.
getAboutWindowVersion :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “version
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #version
setAboutWindowVersion :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “version
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #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 [methodaboutWindow
.add_link].
Since: 1.2
constructAboutWindowWebsite :: (IsAboutWindow 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
.
getAboutWindowWebsite :: (MonadIO m, IsAboutWindow o) => o -> m Text Source #
Get the value of the “website
” property.
When overloading is enabled, this is equivalent to
get
aboutWindow #website
setAboutWindowWebsite :: (MonadIO m, IsAboutWindow o) => o -> Text -> m () Source #
Set the value of the “website
” property.
When overloading is enabled, this is equivalent to
set
aboutWindow [ #website:=
value ]
Signals
activateLink
type AboutWindowActivateLinkCallback Source #
Emitted when a URL is activated.
Applications may connect to it to override the default behavior, which is
to call showUri
.
Since: 1.2
afterAboutWindowActivateLink :: (IsAboutWindow a, MonadIO m) => a -> ((?self :: a) => AboutWindowActivateLinkCallback) -> 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
aboutWindow #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.
onAboutWindowActivateLink :: (IsAboutWindow a, MonadIO m) => a -> ((?self :: a) => AboutWindowActivateLinkCallback) -> 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
aboutWindow #activateLink callback