Package org.gnome.gtk

Class AboutDialog.Builder<B extends AboutDialog.Builder<B>>

java.lang.Object

org.javagi.gobject.Builder<B>

org.gnome.gobject.GObject.Builder<B>

org.gnome.gobject.InitiallyUnowned.Builder<B>

org.gnome.gtk.Widget.Builder<B>

org.gnome.gtk.Window.Builder<B>

org.gnome.gtk.AboutDialog.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

Accessible.Builder<B>, BuilderInterface

Enclosing class:

AboutDialog

public static class AboutDialog.Builder<B extends AboutDialog.Builder<B>>
extends Window.Builder<B>
implements Accessible.Builder<B>

Inner class implementing a builder pattern to construct a GObject with properties.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Default constructor for a Builder object.

Method Summary

Modifier and Type	Method	Description
AboutDialog	build()	Finish building the AboutDialog object.
B	onActivateLink(AboutDialog.ActivateLinkCallback handler)	Emitted every time a URL is activated.
B	setArtists(String[] artists)	The people who contributed artwork to the program.
B	setAuthors(String[] authors)	The authors of the program.
B	setComments(String comments)	Comments about the program.
B	setCopyright(String copyright)	Copyright information for the program.
B	setDocumenters(String[] documenters)	The people documenting the program.
B	setLicense(String license)	The license of the program, as free-form text.
B	setLicenseType(License licenseType)	The license of the program.
B	setLogo(Paintable logo)	A logo for the about box.
B	setLogoIconName(String logoIconName)	A named icon to use as the logo for the about box.
B	setProgramName(String programName)	The name of the program.
B	setSystemInformation(String systemInformation)	Information about the system on which the program is running.
B	setTranslatorCredits(String translatorCredits)	Credits to the translators.
B	setVersion(String version)	The version of the program.
B	setWebsite(String website)	The URL for the link to the website of the program.
B	setWebsiteLabel(String websiteLabel)	The label for the link to the website of the program.
B	setWrapLicense(boolean wrapLicense)	Whether to wrap the text in the license dialog.

Methods inherited from class org.gnome.gtk.Window.Builder

onActivateDefault, onActivateFocus, onCloseRequest, onEnableDebugging, onKeysChanged, setApplication, setChild, setDecorated, setDefaultHeight, setDefaultWidget, setDefaultWidth, setDeletable, setDestroyWithParent, setDisplay, setFocusVisible, setFocusWidget, setFullscreened, setGravity, setHandleMenubarAccel, setHideOnClose, setIconName, setMaximized, setMnemonicsVisible, setModal, setResizable, setStartupId, setTitle, setTitlebar, setTransientFor

Methods inherited from class org.gnome.gtk.Widget.Builder

onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, setCanFocus, setCanTarget, setCssClasses, setCssName, setCursor, setFocusable, setFocusOnClick, setHalign, setHasTooltip, setHeightRequest, setHexpand, setHexpandSet, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setReceivesDefault, setSensitive, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, setWidthRequest

Methods inherited from class org.gnome.gobject.GObject.Builder

onNotify

Methods inherited from class org.javagi.gobject.Builder

addBuilderProperty, connect, connect, connectSignals, getArena, getNames, getValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gnome.gtk.Accessible.Builder

setAccessibleRole

Methods inherited from interface org.javagi.gobject.BuilderInterface

addBuilderProperty, connect, connect, getArena

Constructor Details

Builder

protected Builder()

Default constructor for a Builder object.

Method Details

build

public AboutDialog build()

Finish building the AboutDialog object. This will call GObject.withProperties(org.gnome.glib.Type, java.lang.String[], org.gnome.gobject.Value[]) to create a new GObject instance, which is then cast to AboutDialog.

Overrides:

build in class Window.Builder<B extends AboutDialog.Builder<B>>

Returns:

a new instance of AboutDialog with the properties that were set in the Builder object.

setArtists

public B setArtists(String[] artists)

The people who contributed artwork to the program.

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

Parameters:

artists - the value for the artists property

Returns:

the Builder instance is returned, to allow method chaining

setAuthors

public B setAuthors(String[] authors)

The authors of the program.

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

Parameters:

authors - the value for the authors property

Returns:

the Builder instance is returned, to allow method chaining

setComments

public B setComments(String comments)

Comments about the program.

This string is displayed in a label in the main dialog, thus it should be a short explanation of the main purpose of the program, not a detailed list of features.

Parameters:

comments - the value for the comments property

Returns:

the Builder instance is returned, to allow method chaining

setCopyright

public B setCopyright(String copyright)

Copyright information for the program.

Parameters:

copyright - the value for the copyright property

Returns:

the Builder instance is returned, to allow method chaining

setDocumenters

public B setDocumenters(String[] documenters)

The people documenting the program.

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

Parameters:

documenters - the value for the documenters property

Returns:

the Builder instance is returned, to allow method chaining

setLicense

public B setLicense(String license)

The license of the program, as free-form text.

This string is displayed in a text view in a secondary dialog, therefore it is fine to use a long multi-paragraph text. Note that the text is only wrapped in the text view if the "wrap-license" property is set to TRUE; otherwise the text itself must contain the intended linebreaks.

When setting this property to a non-NULL value, the Gtk.AboutDialog:license-type property is set to Gtk.License.custom as a side effect.

The text may contain links in this format <http://www.some.place/> and email references in the form <mail-to&#64;some.body>, and these will be converted into clickable links.

Parameters:

license - the value for the license property

Returns:

the Builder instance is returned, to allow method chaining

setLicenseType

public B setLicenseType(License licenseType)

The license of the program.

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

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

If Gtk.License.custom is used, the current contents of the Gtk.AboutDialog:license property are used.

For any other Gtk.License value, the contents of the Gtk.AboutDialog:license property are also set by this property as a side effect.

Parameters:

licenseType - the value for the license-type property

Returns:

the Builder instance is returned, to allow method chaining

setLogo

public B setLogo(Paintable logo)

A logo for the about box.

If it is NULL, the default window icon set with Window.setDefaultIconName(java.lang.String) will be used.

Parameters:

logo - the value for the logo property

Returns:

the Builder instance is returned, to allow method chaining

setLogoIconName

public B setLogoIconName(String logoIconName)

A named icon to use as the logo for the about box.

This property overrides the Gtk.AboutDialog:logo property.

Parameters:

logoIconName - the value for the logo-icon-name property

Returns:

the Builder instance is returned, to allow method chaining

setProgramName

public B setProgramName(String programName)

The name of the program.

If this is not set, it defaults to the value returned by GLib.getApplicationName().

Parameters:

programName - the value for the program-name property

Returns:

the Builder instance is returned, to allow method chaining

setSystemInformation

public B setSystemInformation(String systemInformation)

Information about the system on which the program is running.

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

The text may contain links in this format <http://www.some.place/> and email references in the form <mail-to&#64;some.body>, and these will be converted into clickable links.

Parameters:

systemInformation - the value for the system-information property

Returns:

the Builder instance is returned, to allow method chaining

setTranslatorCredits

public B setTranslatorCredits(String translatorCredits)

Credits to the translators.

This string should be marked as translatable.

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

Parameters:

translatorCredits - the value for the translator-credits property

Returns:

the Builder instance is returned, to allow method chaining

setVersion

public B setVersion(String version)

The version of the program.

Parameters:

version - the value for the version property

Returns:

the Builder instance is returned, to allow method chaining

setWebsite

public B setWebsite(String website)

The URL for the link to the website of the program.

This should be a string starting with http:// or https://.

Parameters:

website - the value for the website property

Returns:

the Builder instance is returned, to allow method chaining

setWebsiteLabel

public B setWebsiteLabel(String websiteLabel)

The label for the link to the website of the program.

Parameters:

websiteLabel - the value for the website-label property

Returns:

the Builder instance is returned, to allow method chaining

setWrapLicense

public B setWrapLicense(boolean wrapLicense)

Whether to wrap the text in the license dialog.

Parameters:

wrapLicense - the value for the wrap-license property

Returns:

the Builder instance is returned, to allow method chaining

onActivateLink

public B onActivateLink(AboutDialog.ActivateLinkCallback handler)

Emitted every time a URL is activated.

Applications may connect to it to override the default behaviour, which is to call FileLauncher.launch(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• AboutDialog.ActivateLinkCallback.run(java.lang.String)