class: AboutDialogMeta

[873:14] static extends: object

Generated metadata helpers for AboutDialog class surfaces.

Methods

• properties ()

  Returns property metadata for AboutDialog.

  • @r A list.

• signals ()

  Returns signal metadata for AboutDialog.

  • @r A list.

class: AboutDialog

[40:7] extends: object

Displays 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. About dialogs often contain links and email addresses. GtkAboutDialog displays these as clickable links. By default, it calls [method@Gtk.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 an about dialog 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 an about dialog, as shown in the following example: c 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); ## Shortcuts and Gestures GtkAboutDialog supports the following keyboard shortcuts: - Escape closes the window. ## CSS nodes GtkAboutDialog has a single CSS node with the name window and style class .aboutdialog.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• AboutDialog ()

  Creates a new GtkAboutDialog.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asWindow ()

  Wraps this handle as Window.

  • @r A Window object.

• asAccessible ()

  Wraps this handle as Accessible.

  • @r A Accessible object.

• asBuildable ()

  Wraps this handle as Buildable.

  • @r A Buildable object.

• asConstraintTarget ()

  Wraps this handle as ConstraintTarget.

  • @r A ConstraintTarget object.

• asNative ()

  Wraps this handle as Native.

  • @r A Native object.

• asRoot ()

  Wraps this handle as Root.

  • @r A Root object.

• asShortcutManager ()

  Wraps this handle as ShortcutManager.

  • @r A ShortcutManager object.

• connectSignal (string Name, CallbackObj)

  Connects one generated callback wrapper to a named signal.

  • @p Name is the signal name.
  • @p CallbackObj is the generated callback wrapper to connect.
  • @r The connected handler id.

• disconnectSignalHandler (int HandlerId)

  Disconnects one retained signal handler id.

  • @p HandlerId is the signal handler id to disconnect.
  • @r None.

• setOnActivatelink (callback Fn, UserData = null)

  Emitted every time a URL is activated. Applications may connect to it to override the default behaviour, which is to call [method@Gtk.FileLauncher.launch].

  • @p Fn is the Aussom callback.
  • @p Fn is called with (AboutDialog Self, string Uri).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• getProperty (string Name)

  Reads one generated property by name.

• setProperty (string Name, Value)

  Writes one generated property by name.

• setComments (string Value)

  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.

  • @p Value is the new property value.
  • @r None.

• setCopyright (string Value)

  Copyright information for the program.

  • @p Value is the new property value.
  • @r None.

• setLicense (string Value)

  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 [property@Gtk.AboutDialog:license-type] property is set to [enum@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@some.body>, and these will be converted into clickable links.

  • @p Value is the new property value.
  • @r None.

• setLicensetype (string Value)

  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 [enum@Gtk.License.unknown] is used, the link used will be the same specified in the [property@Gtk.AboutDialog:website] property. If [enum@Gtk.License.custom] is used, the current contents of the [property@Gtk.AboutDialog:license] property are used. For any other [enum@Gtk.License] value, the contents of the [property@Gtk.AboutDialog:license] property are also set by this property as a side effect.

  • @p Value is the new property value.
  • @r None.

• setLogo (object Value)

  A logo for the about box. If it is NULL, the default window icon set with [func@Gtk.Window.set_default_icon_name] will be used.

  • @p Value is the new property value.
  • @r None.

• setLogoiconname (string Value)

  A named icon to use as the logo for the about box. This property overrides the [property@Gtk.AboutDialog:logo] property.

  • @p Value is the new property value.
  • @r None.

• setProgramname (string Value)

  The name of the program. If this is not set, it defaults to the value returned by [func@GLib.get_application_name].

  • @p Value is the new property value.
  • @r None.

• setSysteminformation (string Value)

  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@some.body>, and these will be converted into clickable links.

  • @p Value is the new property value.
  • @r None.

• setTranslatorcredits (string Value)

  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.

  • @p Value is the new property value.
  • @r None.

• setVersion (string Value)

  The version of the program.

  • @p Value is the new property value.
  • @r None.

• setWebsite (string Value)

  The URL for the link to the website of the program. This should be a string starting with http:// or https://.

  • @p Value is the new property value.
  • @r None.

• setWebsitelabel (string Value)

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

  • @p Value is the new property value.
  • @r None.

• setWraplicense (bool Value)

  Whether to wrap the text in the license dialog.

  • @p Value is the new property value.
  • @r None.

• add_credit_section (string section_name, list people)

  Creates a new section in the "Credits" page.

  • @p section_name is The name of the section.
  • @p people is the people who belong to that section.
  • @r None.

• get_artists ()

  Returns the names of the artists which are displayed in the credits page.

• get_authors ()

  Returns the names of the authors which are displayed in the credits page.

• get_comments ()

  Returns the comments string.

• get_copyright ()

  Returns the copyright string.

• get_documenters ()

  Returns the name of the documenters which are displayed in the credits page.

• get_license ()

  Returns the license information.

• get_license_type ()

  Retrieves the license type.

• get_logo ()

  Returns the paintable displayed as logo in the about dialog.

• get_logo_icon_name ()

  Returns the icon name displayed as logo in the about dialog.

• get_program_name ()

  Returns the program name displayed in the about dialog.

• get_system_information ()

  Returns the system information that is shown in the about dialog.

• get_translator_credits ()

  Returns the translator credits string which is displayed in the credits page.

• get_version ()

  Returns the version string.

• get_website ()

  Returns the website URL.

• get_website_label ()

  Returns the label used for the website link.

• get_wrap_license ()

  Returns whether the license text in the about dialog is automatically wrapped.

• set_artists (list artists)

  Sets the names of the artists to be displayed in the "Credits" page.

  • @p artists is the authors of the artwork of the application.
  • @r None.

• set_authors (list authors)

  Sets the names of the authors which are displayed in the "Credits" page of the about dialog.

  • @p authors is the authors of the application.
  • @r None.

• set_comments (string comments)

  Sets the comments string to display in the about dialog. This should be a short string of one or two lines.

  • @p comments is a comments string.
  • @r None.

• set_copyright (string copyright)

  Sets the copyright string to display in the about dialog. This should be a short string of one or two lines.

  • @p copyright is the copyright string.
  • @r None.

• set_documenters (list documenters)

  Sets the names of the documenters which are displayed in the "Credits" page.

  • @p documenters is the authors of the documentation of the application.
  • @r None.

• set_license (string license)

  Sets the license information to be displayed in the about dialog. If license is NULL, the license page is hidden.

  • @p license is the license information.
  • @r None.

• set_license_type (string license_type)

  Sets the license of the application showing the about dialog from a list of known licenses. This function overrides the license set using [method@Gtk.AboutDialog.set_license].

  • @p license_type is the type of license.
  • @r None.

• set_logo (object logo)

  Sets the logo in the about dialog.

  • @p logo is a GdkPaintable.
  • @r None.

• set_logo_icon_name (string icon_name)

  Sets the icon name to be displayed as logo in the about dialog.

  • @p icon_name is an icon name.
  • @r None.

• set_program_name (string name)

  Sets the name to display in the about dialog. If name is not set, the string returned by g_get_application_name() is used.

  • @p name is the program name.
  • @r None.

• set_system_information (string system_information)

  Sets the system information to be displayed in the about dialog. If system_information is NULL, the system information page is hidden. See [property@Gtk.AboutDialog:system-information].

  • @p system_information is system information.
  • @r None.

• set_translator_credits (string translator_credits)

  Sets the translator credits string which is displayed in the credits page. The intended use for this string is to display the translator of the language which is currently used in the user interface. Using gettext(), a simple way to achieve that is to mark the string for translation: c GtkWidget *about = gtk_about_dialog_new (); gtk_about_dialog_set_translator_credits (GTK_ABOUT_DIALOG (about), _("translator-credits")); It is a good idea to use the customary msgid “translator-credits” for this purpose, since translators will already know the purpose of that msgid, and since GtkAboutDialog will detect if “translator-credits” is untranslated and omit translator credits.

  • @p translator_credits is the translator credits.
  • @r None.

• set_version (string version)

  Sets the version string to display in the about dialog.

  • @p version is the version string.
  • @r None.

• set_website (string website)

  Sets the URL to use for the website link.

  • @p website is a URL string starting with http://.
  • @r None.

• set_website_label (string website_label)

  Sets the label to be used for the website link.

  • @p website_label is the label used for the website link.
  • @r None.

• set_wrap_license (bool wrap_license)

  Sets whether the license text in the about dialog should be automatically wrapped.

  • @p wrap_license is whether to wrap the license.
  • @r None.

class: AboutDialogActivatelinkCallback

[803:7] extends: object

Generated low-level callback wrapper for GIR callback activate-link.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• AboutDialogActivatelinkCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, uri, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.