Skip to main content

Type Alias: GtkAboutDialogProps

GtkAboutDialogProps = Omit<GtkWindowProps, "onNotify"> & object

Defined in: generated/jsx.ts:849

Props for the GtkAboutDialog widget.

Type Declaration

NameTypeDescriptionDefined in
artists?string[]The people who contributed artwork to the program. Each string may contain email addresses and URLs, which will be displayed as links.generated/jsx.ts:856
authors?string[]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.generated/jsx.ts:863
children?ReactNode-generated/jsx.ts:976
comments?string | nullComments 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.generated/jsx.ts:871
copyright?string | nullCopyright information for the program.generated/jsx.ts:873
documenters?string[]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.generated/jsx.ts:880
license?string | nullThe 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 AboutDialog.license-type property is set to 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-tosome.body>, and these will be converted into clickable links.generated/jsx.ts:897
licenseType?Gtk.LicenseThe 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 License.unknown is used, the link used will be the same specified in the AboutDialog.website property. If License.custom is used, the current contents of the AboutDialog.license property are used. For any other License value, the contents of the AboutDialog.license property are also set by this property as a side effect.generated/jsx.ts:915
logo?Gdk.Paintable | nullA logo for the about box. If it is NULL, the default window icon set with Window.set_default_icon_name will be used.generated/jsx.ts:922
logoIconName?string | nullA named icon to use as the logo for the about box. This property overrides the AboutDialog.logo property.generated/jsx.ts:928
onActivateLink()?(self, uri) => boolean | nullEmitted every time a URL is activated. Applications may connect to it to override the default behaviour, which is to call FileLauncher.launch.generated/jsx.ts:975
onNotify?(self, propName) => void | nullCalled when any property on this widget changes. Param The widget that emitted the notification Param The name of the property that changed (in kebab-case)generated/jsx.ts:982
programName?string | nullThe name of the program. If this is not set, it defaults to the value returned by GLibget_application_name.generated/jsx.ts:935
ref?Ref<Gtk.AboutDialog>-generated/jsx.ts:1004
systemInformation?string | nullInformation 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-tosome.body>, and these will be converted into clickable links.generated/jsx.ts:947
translatorCredits?string | nullCredits 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.generated/jsx.ts:956
version?string | nullThe version of the program.generated/jsx.ts:958
website?string | nullThe URL for the link to the website of the program. This should be a string starting with http:// or https://.generated/jsx.ts:964
websiteLabel?string | nullThe label for the link to the website of the program.generated/jsx.ts:966
wrapLicense?booleanWhether to wrap the text in the license dialog.generated/jsx.ts:968