Package ch.bailu.gtk.adw
Class AboutWindow
- All Implemented Interfaces:
PointerInterface
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 [property@AboutWindow:application-icon],
[property@AboutWindow:application-name],
[property@AboutWindow:developer-name] and [property@AboutWindow:version]
respectively.
## What's New
`AdwAboutWindow` provides a way for applications to display their release
notes, set with the [property@AboutWindow:release-notes] property.
Release notes are formatted the same way as
[AppStream descriptions](https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-description).
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 [property@AboutWindow:version]. Use
[property@AboutWindow:release-notes-version] to override it.
## Details
The Details page displays the application comments and links.
The comments can be set with the [property@AboutWindow:comments] property.
Unlike [property@Gtk.AboutDialog:comments], this string can be long and
detailed. It can also contain links and Pango markup.
To set the application website, use [property@AboutWindow:website].
To add extra links below the website, use [method@AboutWindow.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
[property@AboutWindow: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, [property@AboutWindow: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 [method@AboutWindow.add_credit_section] to add them.
The Acknowledgements page can be used to acknowledge additional people and
organizations for their non-development contributions. Use
[method@AboutWindow.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 [property@AboutWindow: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 [property@AboutWindow:license-type] property. If the application's
license is not in the list, [property@AboutWindow:license] can be used
instead.
To add information about other modules, such as application dependencies or
data, use [method@AboutWindow.add_legal_section].
## Constructing
To make constructing an `AdwAboutWindow` as convenient as possible, you can
use the function [func@show_about_window] which constructs and shows a
window.
```c
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`.
<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 [property@AboutWindow:application-icon],
[property@AboutWindow:application-name],
[property@AboutWindow:developer-name] and [property@AboutWindow:version]
respectively.
## What's New
`AdwAboutWindow` provides a way for applications to display their release
notes, set with the [property@AboutWindow:release-notes] property.
Release notes are formatted the same way as
[AppStream descriptions](https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-description).
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 [property@AboutWindow:version]. Use
[property@AboutWindow:release-notes-version] to override it.
## Details
The Details page displays the application comments and links.
The comments can be set with the [property@AboutWindow:comments] property.
Unlike [property@Gtk.AboutDialog:comments], this string can be long and
detailed. It can also contain links and Pango markup.
To set the application website, use [property@AboutWindow:website].
To add extra links below the website, use [method@AboutWindow.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
[property@AboutWindow: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, [property@AboutWindow: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 [method@AboutWindow.add_credit_section] to add them.
The Acknowledgements page can be used to acknowledge additional people and
organizations for their non-development contributions. Use
[method@AboutWindow.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 [property@AboutWindow: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 [property@AboutWindow:license-type] property. If the application's
license is not in the list, [property@AboutWindow:license] can be used
instead.
To add information about other modules, such as application dependencies or
data, use [method@AboutWindow.add_legal_section].
## Constructing
To make constructing an `AdwAboutWindow` as convenient as possible, you can
use the function [func@show_about_window] which constructs and shows a
window.
```c
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`.
https://gnome.pages.gitlab.gnome.org/libadwaita/doc/main/class.AboutWindow.html
-
Nested Class Summary
Nested classes/interfaces inherited from class ch.bailu.gtk.gtk.Window
Window.OnActivateDefault, Window.OnActivateFocus, Window.OnCloseRequest, Window.OnEnableDebugging, Window.OnKeysChanged
Nested classes/interfaces inherited from class ch.bailu.gtk.gtk.Widget
Widget.OnDestroy, Widget.OnDestroyNotify, Widget.OnDirectionChanged, Widget.OnHide, Widget.OnKeynavFailed, Widget.OnMap, Widget.OnMnemonicActivate, Widget.OnMoveFocus, Widget.OnQueryTooltip, Widget.OnRealize, Widget.OnShow, Widget.OnStateFlagsChanged, Widget.OnTickCallback, Widget.OnUnmap, Widget.OnUnrealize
Nested classes/interfaces inherited from class ch.bailu.gtk.gobject.Object
Object.OnBindingTransformFunc, Object.OnDuplicateFunc, Object.OnNotify, Object.OnToggleNotify, Object.OnWeakNotify
-
Field Summary
Fields inherited from class ch.bailu.gtk.gtk.Window
SIGNAL_ON_ACTIVATE_DEFAULT, SIGNAL_ON_ACTIVATE_FOCUS, SIGNAL_ON_CLOSE_REQUEST, SIGNAL_ON_ENABLE_DEBUGGING, SIGNAL_ON_KEYS_CHANGED
Fields inherited from class ch.bailu.gtk.gtk.Widget
SIGNAL_ON_DESTROY, SIGNAL_ON_DIRECTION_CHANGED, SIGNAL_ON_HIDE, SIGNAL_ON_KEYNAV_FAILED, SIGNAL_ON_MAP, SIGNAL_ON_MNEMONIC_ACTIVATE, SIGNAL_ON_MOVE_FOCUS, SIGNAL_ON_QUERY_TOOLTIP, SIGNAL_ON_REALIZE, SIGNAL_ON_SHOW, SIGNAL_ON_STATE_FLAGS_CHANGED, SIGNAL_ON_UNMAP, SIGNAL_ON_UNREALIZE
Fields inherited from class ch.bailu.gtk.gobject.Object
SIGNAL_ON_NOTIFY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAcknowledgementSection
(Str name, Strs people) Adds a section to the Acknowledgements page.void
addAcknowledgementSection
(String name, Strs people) Adds a section to the Acknowledgements page.void
addCreditSection
(Str name, Strs people) Adds an extra section to the Credits page.void
addCreditSection
(String name, Strs people) Adds an extra section to the Credits page.void
addLegalSection
(Str title, Str copyright, int license_type, Str license) Adds an extra section to the Legal page.void
addLegalSection
(String title, String copyright, int license_type, String license) Adds an extra section to the Legal page.void
Adds an extra link to the Details page.void
Adds an extra link to the Details page.Implements interfaceAccessible
.Implements interfaceBuildable
.Implements interfaceConstraintTarget
.asNative()
Implements interfaceNative
.asRoot()
Implements interfaceRoot
.Implements interfaceShortcutManager
.Gets the name of the application icon for @self.Gets the application name for @self.Gets the list of artists of the application.static ClassHandler
Gets the comments about the application.Gets the copyright information for @self.Gets the debug information for @self.Gets the debug information filename for @self.Gets the list of designers of the application.Gets the developer name for @self.Gets the list of developers of the application.Gets the list of documenters of the application.static int
Gets the issue tracker URL for @self.Gets the license for @self.int
Gets the license type for @self.static long
static TypeSystem.TypeSize
Gets the release notes for @self.Gets the version described by the application's release notes.Gets the URL of the support page for @self.Gets the translator credits string.static long
static TypeSystem.TypeSize
Gets the version for @self.Gets the application website URL for @self.Connect to signal "activate-link".void
setApplicationIcon
(Str application_icon) Sets the name of the application icon for @self.void
setApplicationIcon
(String application_icon) Sets the name of the application icon for @self.void
setApplicationName
(Str application_name) Sets the application name for @self.void
setApplicationName
(String application_name) Sets the application name for @self.void
setArtists
(Strs artists) Sets the list of artists of the application.void
setComments
(Str comments) Sets the comments about the application.void
setComments
(String comments) Sets the comments about the application.void
setCopyright
(Str copyright) Sets the copyright information for @self.void
setCopyright
(String copyright) Sets the copyright information for @self.void
setDebugInfo
(Str debug_info) Sets the debug information for @self.void
setDebugInfo
(String debug_info) Sets the debug information for @self.void
setDebugInfoFilename
(Str filename) Sets the debug information filename for @self.void
setDebugInfoFilename
(String filename) Sets the debug information filename for @self.void
setDesigners
(Strs designers) Sets the list of designers of the application.void
setDeveloperName
(Str developer_name) Sets the developer name for @self.void
setDeveloperName
(String developer_name) Sets the developer name for @self.void
setDevelopers
(Strs developers) Sets the list of developers of the application.void
setDocumenters
(Strs documenters) Sets the list of documenters of the application.void
setIssueUrl
(Str issue_url) Sets the issue tracker URL for @self.void
setIssueUrl
(String issue_url) Sets the issue tracker URL for @self.void
setLicense
(Str license) Sets the license for @self.void
setLicense
(String license) Sets the license for @self.void
setLicenseType
(int license_type) Sets the license for @self from a list of known licenses.void
setReleaseNotes
(Str release_notes) Sets the release notes for @self.void
setReleaseNotes
(String release_notes) Sets the release notes for @self.void
setReleaseNotesVersion
(Str version) Sets the version described by the application's release notes.void
setReleaseNotesVersion
(String version) Sets the version described by the application's release notes.void
setSupportUrl
(Str support_url) Sets the URL of the support page for @self.void
setSupportUrl
(String support_url) Sets the URL of the support page for @self.void
setTranslatorCredits
(Str translator_credits) Sets the translator credits string.void
setTranslatorCredits
(String translator_credits) Sets the translator credits string.void
setVersion
(Str version) Sets the version for @self.void
setVersion
(String version) Sets the version for @self.void
setWebsite
(Str website) Sets the application website URL for @self.void
setWebsite
(String website) Sets the application website URL for @self.Methods inherited from class ch.bailu.gtk.adw.Window
getContent, setContent
Methods inherited from class ch.bailu.gtk.gtk.Window
close, destroy, fullscreen, fullscreenOnMonitor, getApplication, getChild, getDecorated, getDefaultIconName, getDefaultSize, getDefaultWidget, getDeletable, getDestroyWithParent, getFocus, getFocusVisible, getGroup, getHandleMenubarAccel, getHideOnClose, getIconName, getMnemonicsVisible, getModal, getResizable, getTitle, getTitlebar, getToplevels, getTransientFor, hasGroup, isActive, isFullscreen, isMaximized, listToplevels, maximize, minimize, onActivateDefault, onActivateFocus, onCloseRequest, onEnableDebugging, onKeysChanged, present, presentWithTime, setApplication, setAutoStartupNotification, setChild, setDecorated, setDefaultIconName, setDefaultSize, setDefaultWidget, setDeletable, setDestroyWithParent, setDisplay, setFocus, setFocusVisible, setHandleMenubarAccel, setHideOnClose, setIconName, setIconName, setInteractiveDebugging, setMnemonicsVisible, setModal, setResizable, setStartupId, setStartupId, setTitle, setTitle, setTitlebar, setTransientFor, unfullscreen, unmaximize, unminimize
Methods inherited from class ch.bailu.gtk.gtk.Widget
actionSetEnabled, actionSetEnabled, activate, activateAction, activateAction, activateActionVariant, activateActionVariant, activateDefault, addController, addCssClass, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getCanFocus, getCanTarget, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeCssClass, removeMnemonicLabel, removeTickCallback, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipMarkup, setTooltipText, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, snapshotChild, triggerTooltipQuery, unmap, unparent, unrealize, unsetStateFlags
Methods inherited from class ch.bailu.gtk.gobject.Object
addToggleRef, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, disconnect, disconnect, dupData, dupData, dupQdata, forceFloating, freezeNotify, get, get, getData, getData, getProperty, getProperty, getQdata, interfaceFindProperty, interfaceInstallProperty, isFloating, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, replaceData, replaceData, replaceQdata, runDispose, set, set, setData, setData, setDataFull, setDataFull, setProperty, setProperty, setQdata, setQdataFull, stealData, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref
Methods inherited from class ch.bailu.gtk.type.Pointer
asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacks
Methods inherited from class ch.bailu.gtk.type.Type
asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNull
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface ch.bailu.gtk.type.PointerInterface
asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull
-
Field Details
-
SIGNAL_ON_ACTIVATE_LINK
- See Also:
-
-
Constructor Details
-
AboutWindow
-
AboutWindow
public AboutWindow()Creates a new `AdwAboutWindow`.
-
-
Method Details
-
getClassHandler
-
addAcknowledgementSection
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]- Parameters:
name
- the section namepeople
- the list of names
-
addAcknowledgementSection
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]- Parameters:
name
- the section namepeople
- the list of names
-
addCreditSection
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]- Parameters:
name
- the section namepeople
- the list of names
-
addCreditSection
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]- Parameters:
name
- the section namepeople
- the list of names
-
addLegalSection
public void addLegalSection(@Nonnull Str title, @Nullable Str copyright, int license_type, @Nullable Str license) Adds an extra section to the Legal page.
Extra sections will be displayed below the application's own information.
The parameters @copyright, @license_type and @license will be used to present
the it the same way as [property@AboutWindow:copyright],
[property@AboutWindow:license-type] and [property@AboutWindow: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
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.");
```- Parameters:
title
- the name of the sectioncopyright
- a copyright stringlicense_type
- the type of licenselicense
- custom license information
-
addLegalSection
Adds an extra section to the Legal page.
Extra sections will be displayed below the application's own information.
The parameters @copyright, @license_type and @license will be used to present
the it the same way as [property@AboutWindow:copyright],
[property@AboutWindow:license-type] and [property@AboutWindow: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
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.");
```- Parameters:
title
- the name of the sectioncopyright
- a copyright stringlicense_type
- the type of licenselicense
- custom license information
-
addLink
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 [property@AboutWindow:website].- Parameters:
title
- the link titleurl
- the link URL
-
addLink
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 [property@AboutWindow:website].- Parameters:
title
- the link titleurl
- the link URL
-
getApplicationIcon
Gets the name of the application icon for @self.- Returns:
- the application icon name
-
getApplicationName
Gets the application name for @self.- Returns:
- the application name
-
getArtists
Gets the list of artists of the application.- Returns:
- The list of artists
-
getComments
Gets the comments about the application.- Returns:
- the comments
-
getCopyright
Gets the copyright information for @self.- Returns:
- the copyright information
-
getDebugInfo
Gets the debug information for @self.- Returns:
- the debug information
-
getDebugInfoFilename
Gets the debug information filename for @self.- Returns:
- the debug information filename
-
getDesigners
Gets the list of designers of the application.- Returns:
- The list of designers
-
getDeveloperName
Gets the developer name for @self.- Returns:
- the developer_name
-
getDevelopers
Gets the list of developers of the application.- Returns:
- The list of developers
-
getDocumenters
Gets the list of documenters of the application.- Returns:
- The list of documenters
-
getIssueUrl
Gets the issue tracker URL for @self.- Returns:
- the issue tracker URL
-
getLicense
Gets the license for @self.- Returns:
- the license
-
getLicenseType
public int getLicenseType()Gets the license type for @self.- Returns:
- the license type
-
getReleaseNotes
Gets the release notes for @self.- Returns:
- the release notes
-
getReleaseNotesVersion
Gets the version described by the application's release notes.- Returns:
- the release notes version
-
getSupportUrl
Gets the URL of the support page for @self.- Returns:
- the support page URL
-
getTranslatorCredits
Gets the translator credits string.- Returns:
- The translator credits string
-
getVersion
Gets the version for @self.- Returns:
- the version
-
getWebsite
Gets the application website URL for @self.- Returns:
- the website URL
-
setApplicationIcon
Sets the name of the application icon for @self.
The icon is displayed at the top of the main page.- Parameters:
application_icon
- the application icon name
-
setApplicationIcon
Sets the name of the application icon for @self.
The icon is displayed at the top of the main page.- Parameters:
application_icon
- the application icon name
-
setApplicationName
Sets the application name for @self.
The name is displayed at the top of the main page.- Parameters:
application_name
- the application name
-
setApplicationName
Sets the application name for @self.
The name is displayed at the top of the main page.- Parameters:
application_name
- the application name
-
setArtists
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]- Parameters:
artists
- the list of artists
-
setComments
Sets the comments about the application.
Comments will be shown on the Details page, above links.
Unlike [property@Gtk.AboutDialog:comments], this string can be long and
detailed. It can also contain links and Pango markup.- Parameters:
comments
- the comments
-
setComments
Sets the comments about the application.
Comments will be shown on the Details page, above links.
Unlike [property@Gtk.AboutDialog:comments], this string can be long and
detailed. It can also contain links and Pango markup.- Parameters:
comments
- the comments
-
setCopyright
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.- Parameters:
copyright
- the copyright information
-
setCopyright
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.- Parameters:
copyright
- the copyright information
-
setDebugInfo
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, [property@AboutWindow:debug-info-filename] would be used as
the suggested filename.
Debug information cannot contain markup or links.- Parameters:
debug_info
- the debug information
-
setDebugInfo
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, [property@AboutWindow:debug-info-filename] would be used as
the suggested filename.
Debug information cannot contain markup or links.- Parameters:
debug_info
- the debug information
-
setDebugInfoFilename
Sets the debug information filename for @self.
It will be used as the suggested filename when saving debug information to a
file.
See [property@AboutWindow:debug-info].- Parameters:
filename
- the debug info filename
-
setDebugInfoFilename
Sets the debug information filename for @self.
It will be used as the suggested filename when saving debug information to a
file.
See [property@AboutWindow:debug-info].- Parameters:
filename
- the debug info filename
-
setDesigners
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]- Parameters:
designers
- the list of designers
-
setDeveloperName
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 [property@AboutWindow:developers] and related properties.- Parameters:
developer_name
- the developer name
-
setDeveloperName
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 [property@AboutWindow:developers] and related properties.- Parameters:
developer_name
- the developer name
-
setDevelopers
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]- Parameters:
developers
- the list of developers
-
setDocumenters
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]- Parameters:
documenters
- the list of documenters
-
setIssueUrl
Sets the issue tracker URL for @self.
The issue tracker link is displayed on the main page.- Parameters:
issue_url
- the issue tracker URL
-
setIssueUrl
Sets the issue tracker URL for @self.
The issue tracker link is displayed on the main page.- Parameters:
issue_url
- the issue tracker URL
-
setLicense
Sets the license for @self.
This can be used to set a custom text for the license if it can't be set via
[property@AboutWindow:license-type].
When set, [property@AboutWindow: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.- Parameters:
license
- the license
-
setLicense
Sets the license for @self.
This can be used to set a custom text for the license if it can't be set via
[property@AboutWindow:license-type].
When set, [property@AboutWindow: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.- Parameters:
license
- the license
-
setLicenseType
public void setLicenseType(int license_type) Sets the license for @self from a list of known licenses.
If the application's license is not in the list,
[property@AboutWindow:license] can be used instead. The license type will be
automatically set to `GTK_LICENSE_CUSTOM` in that case.
If @license_type is `GTK_LICENSE_UNKNOWN`, no information will be displayed.
If @license_type is different from `GTK_LICENSE_CUSTOM`.
[property@AboutWindow: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.- Parameters:
license_type
- the license type
-
setReleaseNotes
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](https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-description).
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
[property@AboutWindow:release-notes-version] of the property will be used
as the version; otherwise, [property@AboutWindow:version] is used.- Parameters:
release_notes
- the release notes
-
setReleaseNotes
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](https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-description).
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
[property@AboutWindow:release-notes-version] of the property will be used
as the version; otherwise, [property@AboutWindow:version] is used.- Parameters:
release_notes
- the release notes
-
setReleaseNotesVersion
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, [property@AboutWindow: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 [property@AboutWindow:release-notes].- Parameters:
version
- the release notes version
-
setReleaseNotesVersion
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, [property@AboutWindow: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 [property@AboutWindow:release-notes].- Parameters:
version
- the release notes version
-
setSupportUrl
Sets the URL of the support page for @self.
The support page link is displayed on the main page.- Parameters:
support_url
- the support page URL
-
setSupportUrl
Sets the URL of the support page for @self.
The support page link is displayed on the main page.- Parameters:
support_url
- the support page URL
-
setTranslatorCredits
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]- Parameters:
translator_credits
- the translator credits
-
setTranslatorCredits
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]- Parameters:
translator_credits
- the translator credits
-
setVersion
Sets the version for @self.
The version is displayed on the main page.
If [property@AboutWindow:release-notes-version] is not set, the version will
also be displayed above the release notes on the What's New page.- Parameters:
version
- the version
-
setVersion
Sets the version for @self.
The version is displayed on the main page.
If [property@AboutWindow:release-notes-version] is not set, the version will
also be displayed above the release notes on the What's New page.- Parameters:
version
- the version
-
setWebsite
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 [method@AboutWindow.add_link].- Parameters:
website
- the website URL
-
setWebsite
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 [method@AboutWindow.add_link].- Parameters:
website
- the website URL
-
onActivateLink
Connect to signal "activate-link".
SeeAboutWindow.OnActivateLink.onActivateLink(ch.bailu.gtk.type.Str)
for signal description.
FieldSIGNAL_ON_ACTIVATE_LINK
contains original signal name and can be used as resource reference.- Parameters:
signal
- callback function (lambda).- Returns:
SignalHandler
. Can be used to disconnect signal and to release callback function.
-
asAccessible
Implements interfaceAccessible
. Call this to get access to interface functions.- Overrides:
asAccessible
in classWindow
- Returns:
Accessible
-
asBuildable
Implements interfaceBuildable
. Call this to get access to interface functions.- Overrides:
asBuildable
in classWindow
- Returns:
Buildable
-
asConstraintTarget
Implements interfaceConstraintTarget
. Call this to get access to interface functions.- Overrides:
asConstraintTarget
in classWindow
- Returns:
ConstraintTarget
-
asNative
Implements interfaceNative
. Call this to get access to interface functions. -
asRoot
Implements interfaceRoot
. Call this to get access to interface functions. -
asShortcutManager
Implements interfaceShortcutManager
. Call this to get access to interface functions.- Overrides:
asShortcutManager
in classWindow
- Returns:
ShortcutManager
-
getTypeID
public static long getTypeID() -
getParentTypeID
public static long getParentTypeID() -
getTypeSize
-
getParentTypeSize
-
getInstanceSize
public static int getInstanceSize()
-