AboutDialog

The GtkAboutDialog 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. GtkAboutDialog displays these as clickable links. By default, it calls [func@Gtk.show_uri] 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 GtkAboutDialog 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 GtkAboutDialog, 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

GtkAboutDialog has a single CSS node with the name window and style class .aboutdialog.

class AboutDialog : Window {

protected

GtkAboutDialog* gtkAboutDialog;

GtkAboutDialog* getAboutDialogStruct(bool transferOwnership);

void* getStruct();

this(GtkAboutDialog* gtkAboutDialog, bool ownedRef);

static GType getType();

this();

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

string[] getArtists();

string[] getAuthors();

string getComments();

string getCopyright();

string[] getDocumenters();

string getLicense();

GtkLicense getLicenseType();

PaintableIF 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(GtkLicense licenseType);

void setLogo(PaintableIF 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);

gulong addOnActivateLink(bool delegate(string, AboutDialog) dlg, ConnectFlags connectFlags);

}

Constructors

this this(GtkAboutDialog* gtkAboutDialog, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new GtkAboutDialog.

Members

Functions

addCreditSection void addCreditSection(string sectionName, string[] people): Creates a new section in the "Credits" page.
addOnActivateLink gulong addOnActivateLink(bool delegate(string, AboutDialog) dlg, ConnectFlags connectFlags): Emitted every time a URL is activated.
getAboutDialogStruct GtkAboutDialog* getAboutDialogStruct(bool transferOwnership): Get the main Gtk struct
getArtists string[] getArtists(): Returns the string which are displayed in the "Artists" tab of the secondary credits dialog.
getAuthors string[] getAuthors(): Returns the string which are displayed in the authors tab of the secondary credits dialog.
getComments string getComments(): Returns the comments string.
getCopyright string getCopyright(): Returns the copyright string.
getDocumenters string[] getDocumenters(): Returns the string which are displayed in the "Documenters" tab of the secondary credits dialog.
getLicense string getLicense(): Returns the license information.
getLicenseType GtkLicense getLicenseType(): Retrieves the license type.
getLogo PaintableIF 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.
getStruct void* getStruct(): the main Gtk struct as a void*
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 translators tab of the secondary credits dialog.
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 strings which are displayed in the "Artists" tab of the secondary credits dialog.
setAuthors void setAuthors(string[] authors): Sets the strings which are displayed in the "Authors" tab of the secondary credits 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 strings which are displayed in the "Documenters" tab of the credits dialog.
setLicense void setLicense(string license): Sets the license information to be displayed in the secondary license dialog.
setLicenseType void setLicenseType(GtkLicense licenseType): Sets the license of the application showing the about dialog from a list of known licenses.
setLogo void setLogo(PaintableIF 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 translators tab of the secondary credits dialog.
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.

Static functions

getType GType getType()

Variables

gtkAboutDialog GtkAboutDialog* gtkAboutDialog;: the main Gtk struct

Inherited Members

From Window

gtkWindow GtkWindow* gtkWindow;: the main Gtk struct
getWindowStruct GtkWindow* getWindowStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
__anonymous mixin NativeT!(GtkWindow): Undocumented in source.
__anonymous mixin RootT!(GtkWindow): Undocumented in source.
__anonymous mixin ShortcutManagerT!(GtkWindow): Undocumented in source.
getType GType getType()
getDefaultIconName string getDefaultIconName(): Returns the fallback icon name for windows.
getToplevels ListModelIF getToplevels(): Returns a list of all existing toplevel windows.
listToplevels ListG 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(MonitorGdk monitor): Asks to place @window in the fullscreen state on the given @monitor.
getApplication Application getApplication(): Gets the GtkApplication associated with the window.
getChild 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 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 Widget getFocus(): Retrieves the current focused widget within the window.
getFocusVisible bool getFocusVisible(): Gets whether “focus rectangles” are supposed to be visible.
getGroup 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_set_resizable().
getTitle string getTitle(): Retrieves the title of the window.
getTitlebar Widget getTitlebar(): Returns the custom titlebar that has been set with gtk_window_set_titlebar().
getTransientFor 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.
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.
setApplication void setApplication(Application application): Sets or unsets the GtkApplication associated with the window.
setChild void setChild(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(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(Display display): Sets the GdkDisplay where the @window is displayed.
setFocus void setFocus(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 GtkWindow.
setTitlebar void setTitlebar(Widget titlebar): Sets a custom titlebar for @window.
setTransientFor void setTransientFor(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. [ctor@Gtk.Dialog.new_with_buttons] and other convenience functions in GTK will sometimes call gtk_window_set_transient_for() 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.
addOnActivateDefault gulong addOnActivateDefault(void delegate(Window) dlg, ConnectFlags connectFlags): Emitted when the user activates the default widget of @window.
addOnActivateFocus gulong addOnActivateFocus(void delegate(Window) dlg, ConnectFlags connectFlags): Emitted when the user activates the currently focused widget of @window.
addOnCloseRequest gulong addOnCloseRequest(bool delegate(Window) dlg, ConnectFlags connectFlags): Emitted when the user clicks on the close button of the window.
addOnEnableDebugging gulong addOnEnableDebugging(bool delegate(bool, Window) dlg, ConnectFlags connectFlags): Emitted when the user enables or disables interactive debugging.
addOnKeysChanged gulong addOnKeysChanged(void delegate(Window) dlg, ConnectFlags connectFlags): emitted when the set of accelerators or mnemonics that are associated with @window changes.