AboutDialog

The gtk.about_dialog.AboutDialog offers a simple way to display information about a program.

The shown information includes the programs' logo, name, copyright, website and license. It is also possible to give credits to the authors, documenters, translators and artists who have worked on the program.

An about dialog is typically opened when the user selects the About option from the Help menu. All parts of the dialog are optional.

An example GtkAboutDialog

About dialogs often contain links and email addresses. gtk.about_dialog.AboutDialog displays these as clickable links. By default, it calls gtk.file_launcher.FileLauncher.launch when a user clicks one. The behaviour can be overridden with the signal@Gtk.AboutDialog::activate-link signal.

To specify a person with an email address, use a string like Edgar Allan Poe <edgar@poe.com>. To specify a website with a title, use a string like GTK team https://www.gtk.org.

To make constructing a gtk.about_dialog.AboutDialog as convenient as possible, you can use the function func@Gtk.show_about_dialog which constructs and shows a dialog and keeps it around so that it can be shown again.

Note that GTK sets a default title of _("About s") on the dialog window (where `s` is replaced by the name of the application, but in order to ensure proper translation of the title, applications should set the title property explicitly when constructing a gtk.about_dialog.AboutDialog, as shown in the following example:

GFile *logo_file = g_file_new_for_path ("./logo.png");
GdkTexture *example_logo = gdk_texture_new_from_file (logo_file, NULL);
g_object_unref (logo_file);

gtk_show_about_dialog (NULL,
                       "program-name", "ExampleCode",
                       "logo", example_logo,
                       "title", _("About ExampleCode"),
                       NULL);

CSS nodes

gtk.about_dialog.AboutDialog has a single CSS node with the name window and style class .aboutdialog.

class AboutDialog : Window {

this();

void addCreditSection(string sectionName, string[] people);

string[] getArtists();

string[] getAuthors();

string getComments();

string getCopyright();

string[] getDocumenters();

string getLicense();

gtk.types.License getLicenseType();

gdk.paintable.Paintable getLogo();

string getLogoIconName();

string getProgramName();

string getSystemInformation();

string getTranslatorCredits();

string getVersion();

string getWebsite();

string getWebsiteLabel();

bool getWrapLicense();

void setArtists(string[] artists);

void setAuthors(string[] authors);

void setComments(string comments);

void setCopyright(string copyright);

void setDocumenters(string[] documenters);

void setLicense(string license);

void setLicenseType(gtk.types.License licenseType);

void setLogo(gdk.paintable.Paintable logo);

void setLogoIconName(string iconName);

void setProgramName(string name);

void setSystemInformation(string systemInformation);

void setTranslatorCredits(string translatorCredits);

void setVersion(string version_);

void setWebsite(string website);

void setWebsiteLabel(string websiteLabel);

void setWrapLicense(bool wrapLicense);

ulong connectActivateLink(T callback, Flag!"After" after);

}

Constructors

this this(): Creates a new gtk.about_dialog.AboutDialog.

Members

Functions

addCreditSection void addCreditSection(string sectionName, string[] people): Creates a new section in the "Credits" page.
connectActivateLink ulong connectActivateLink(T callback, Flag!"After" after): Connect to ActivateLink signal.
getArtists string[] getArtists(): Returns the names of the artists which are displayed in the credits page.
getAuthors string[] getAuthors(): Returns the names of the authors which are displayed in the credits page.
getComments string getComments(): Returns the comments string.
getCopyright string getCopyright(): Returns the copyright string.
getDocumenters string[] getDocumenters(): Returns the name of the documenters which are displayed in the credits page.
getLicense string getLicense(): Returns the license information.
getLicenseType gtk.types.License getLicenseType(): Retrieves the license type.
getLogo gdk.paintable.Paintable getLogo(): Returns the paintable displayed as logo in the about dialog.
getLogoIconName string getLogoIconName(): Returns the icon name displayed as logo in the about dialog.
getProgramName string getProgramName(): Returns the program name displayed in the about dialog.
getSystemInformation string getSystemInformation(): Returns the system information that is shown in the about dialog.
getTranslatorCredits string getTranslatorCredits(): Returns the translator credits string which is displayed in the credits page.
getVersion string getVersion(): Returns the version string.
getWebsite string getWebsite(): Returns the website URL.
getWebsiteLabel string getWebsiteLabel(): Returns the label used for the website link.
getWrapLicense bool getWrapLicense(): Returns whether the license text in the about dialog is automatically wrapped.
setArtists void setArtists(string[] artists): Sets the names of the artists to be displayed in the "Credits" page.
setAuthors void setAuthors(string[] authors): Sets the names of the authors which are displayed in the "Credits" page of the about dialog.
setComments void setComments(string comments): Sets the comments string to display in the about dialog.
setCopyright void setCopyright(string copyright): Sets the copyright string to display in the about dialog.
setDocumenters void setDocumenters(string[] documenters): Sets the names of the documenters which are displayed in the "Credits" page.
setLicense void setLicense(string license): Sets the license information to be displayed in the about dialog.
setLicenseType void setLicenseType(gtk.types.License licenseType): Sets the license of the application showing the about dialog from a list of known licenses.
setLogo void setLogo(gdk.paintable.Paintable logo): Sets the logo in the about dialog.
setLogoIconName void setLogoIconName(string iconName): Sets the icon name to be displayed as logo in the about dialog.
setProgramName void setProgramName(string name): Sets the name to display in the about dialog.
setSystemInformation void setSystemInformation(string systemInformation): Sets the system information to be displayed in the about dialog.
setTranslatorCredits void setTranslatorCredits(string translatorCredits): Sets the translator credits string which is displayed in the credits page.
setVersion void setVersion(string version_): Sets the version string to display in the about dialog.
setWebsite void setWebsite(string website): Sets the URL to use for the website link.
setWebsiteLabel void setWebsiteLabel(string websiteLabel): Sets the label to be used for the website link.
setWrapLicense void setWrapLicense(bool wrapLicense): Sets whether the license text in the about dialog should be automatically wrapped.

Inherited Members

From Window

getDefaultIconName string getDefaultIconName(): Returns the fallback icon name for windows.
getToplevels gio.list_model.ListModel getToplevels(): Returns a list of all existing toplevel windows.
listToplevels gtk.widget.Widget[] listToplevels(): Returns a list of all existing toplevel windows.
setAutoStartupNotification void setAutoStartupNotification(bool setting): Sets whether the window should request startup notification.
setDefaultIconName void setDefaultIconName(string name): Sets an icon to be used as fallback.
setInteractiveDebugging void setInteractiveDebugging(bool enable): Opens or closes the interactive debugger.
close void close(): Requests that the window is closed.
destroy void destroy(): Drop the internal reference GTK holds on toplevel windows.
fullscreen void fullscreen(): Asks to place window in the fullscreen state.
fullscreenOnMonitor void fullscreenOnMonitor(gdk.monitor.MonitorG monitor): Asks to place window in the fullscreen state on the given monitor.
getApplication gtk.application.Application getApplication(): Gets the gtk.application.Application associated with the window.
getChild gtk.widget.Widget getChild(): Gets the child widget of window.
getDecorated bool getDecorated(): Returns whether the window has been set to have decorations.
getDefaultSize void getDefaultSize(int width, int height): Gets the default size of the window.
getDefaultWidget gtk.widget.Widget getDefaultWidget(): Returns the default widget for window.
getDeletable bool getDeletable(): Returns whether the window has been set to have a close button.
getDestroyWithParent bool getDestroyWithParent(): Returns whether the window will be destroyed with its transient parent.
getFocus gtk.widget.Widget getFocus(): Retrieves the current focused widget within the window.
getFocusVisible bool getFocusVisible(): Gets whether “focus rectangles” are supposed to be visible.
getGroup gtk.window_group.WindowGroup getGroup(): Returns the group for window.
getHandleMenubarAccel bool getHandleMenubarAccel(): Returns whether this window reacts to F10 key presses by activating a menubar it contains.
getHideOnClose bool getHideOnClose(): Returns whether the window will be hidden when the close button is clicked.
getIconName string getIconName(): Returns the name of the themed icon for the window.
getMnemonicsVisible bool getMnemonicsVisible(): Gets whether mnemonics are supposed to be visible.
getModal bool getModal(): Returns whether the window is modal.
getResizable bool getResizable(): Gets the value set by gtk.window.Window.setResizable.
getTitle string getTitle(): Retrieves the title of the window.
getTitlebar gtk.widget.Widget getTitlebar(): Returns the custom titlebar that has been set with gtk.window.Window.setTitlebar.
getTransientFor gtk.window.Window getTransientFor(): Fetches the transient parent for this window.
hasGroup bool hasGroup(): Returns whether window has an explicit window group.
isActive bool isActive(): Returns whether the window is part of the current active toplevel.
isFullscreen bool isFullscreen(): Retrieves the current fullscreen state of window.
isMaximized bool isMaximized(): Retrieves the current maximized state of window.
isSuspended bool isSuspended(): Retrieves the current suspended state of window.
maximize void maximize(): Asks to maximize window, so that it fills the screen.
minimize void minimize(): Asks to minimize the specified window.
present void present(): Presents a window to the user.
presentWithTime void presentWithTime(uint timestamp): Presents a window to the user in response to an user interaction.
setApplication void setApplication(gtk.application.Application application): Sets or unsets the gtk.application.Application associated with the window.
setChild void setChild(gtk.widget.Widget child): Sets the child widget of window.
setDecorated void setDecorated(bool setting): Sets whether the window should be decorated.
setDefaultSize void setDefaultSize(int width, int height): Sets the default size of a window.
setDefaultWidget void setDefaultWidget(gtk.widget.Widget defaultWidget): Sets the default widget.
setDeletable void setDeletable(bool setting): Sets whether the window should be deletable.
setDestroyWithParent void setDestroyWithParent(bool setting): If setting is true, then destroying the transient parent of window will also destroy window itself.
setDisplay void setDisplay(gdk.display.Display display): Sets the gdk.display.Display where the window is displayed.
setFocus void setFocus(gtk.widget.Widget focus): Sets the focus widget.
setFocusVisible void setFocusVisible(bool setting): Sets whether “focus rectangles” are supposed to be visible.
setHandleMenubarAccel void setHandleMenubarAccel(bool handleMenubarAccel): Sets whether this window should react to F10 key presses by activating a menubar it contains.
setHideOnClose void setHideOnClose(bool setting): If setting is true, then clicking the close button on the window will not destroy it, but only hide it.
setIconName void setIconName(string name): Sets the icon for the window from a named themed icon.
setMnemonicsVisible void setMnemonicsVisible(bool setting): Sets whether mnemonics are supposed to be visible.
setModal void setModal(bool modal): Sets a window modal or non-modal.
setResizable void setResizable(bool resizable): Sets whether the user can resize a window.
setStartupId void setStartupId(string startupId): Sets the startup notification ID.
setTitle void setTitle(string title): Sets the title of the gtk.window.Window.
setTitlebar void setTitlebar(gtk.widget.Widget titlebar): Sets a custom titlebar for window.
setTransientFor void setTransientFor(gtk.window.Window parent): Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. gtk.dialog.Dialog.newWithButtons and other convenience functions in GTK will sometimes call gtk.window.Window.setTransientFor on your behalf.
unfullscreen void unfullscreen(): Asks to remove the fullscreen state for window, and return to its previous state.
unmaximize void unmaximize(): Asks to unmaximize window.
unminimize void unminimize(): Asks to unminimize the specified window.
connectActivateDefault ulong connectActivateDefault(T callback, Flag!"After" after): Connect to ActivateDefault signal.
connectActivateFocus ulong connectActivateFocus(T callback, Flag!"After" after): Connect to ActivateFocus signal.
connectCloseRequest ulong connectCloseRequest(T callback, Flag!"After" after): Connect to CloseRequest signal.
connectEnableDebugging ulong connectEnableDebugging(T callback, Flag!"After" after): Connect to EnableDebugging signal.
connectKeysChanged ulong connectKeysChanged(T callback, Flag!"After" after): Connect to KeysChanged signal.

gtk about_dialog classes

AboutDialog