AboutDialog
open class AboutDialog : Window, AboutDialogProtocol
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.
About dialogs often contain links and email addresses. GtkAboutDialog
displays these as clickable links. By default, it calls [funcGtk.show_uri
]
when a user clicks one. The behaviour can be overridden with the
[signalGtk.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 [funcGtk.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
.
The AboutDialog
type acts as a reference-counted owner of an underlying GtkAboutDialog
instance.
It provides the methods that can operate on this data type through AboutDialogProtocol
conformance.
Use AboutDialog
as a strong reference or owner of a GtkAboutDialog
instance.
-
Designated initialiser from the underlying `C` data type.
This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the
AboutDialog
instance.Declaration
Swift
@inlinable public init(_ op: UnsafeMutablePointer<GtkAboutDialog>)
Parameters
op
pointer to the underlying object
-
Designated initialiser from a constant pointer to the underlying
C
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theAboutDialog
instance.Declaration
Swift
@inlinable public init(_ op: UnsafePointer<GtkAboutDialog>)
Parameters
op
pointer to the underlying object
-
Optional initialiser from a non-mutating
gpointer
to the underlyingC
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theAboutDialog
instance.Declaration
Swift
@inlinable override public init!(gpointer op: gpointer?)
Parameters
op
gpointer to the underlying object
-
Optional initialiser from a non-mutating
gconstpointer
to the underlyingC
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theAboutDialog
instance.Declaration
Swift
@inlinable override public init!(gconstpointer op: gconstpointer?)
Parameters
op
pointer to the underlying object
-
Optional initialiser from a constant pointer to the underlying
C
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theAboutDialog
instance.Declaration
Swift
@inlinable public init!(_ op: UnsafePointer<GtkAboutDialog>?)
Parameters
op
pointer to the underlying object
-
Optional initialiser from the underlying
C
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theAboutDialog
instance.Declaration
Swift
@inlinable public init!(_ op: UnsafeMutablePointer<GtkAboutDialog>?)
Parameters
op
pointer to the underlying object
-
Designated initialiser from the underlying
C
data type. Will retainGtkAboutDialog
. i.e., ownership is transferred to theAboutDialog
instance.Declaration
Swift
@inlinable public init(retaining op: UnsafeMutablePointer<GtkAboutDialog>)
Parameters
op
pointer to the underlying object
-
Reference intialiser for a related type that implements
AboutDialogProtocol
Will retainGtkAboutDialog
.Declaration
Swift
@inlinable public init<T>(aboutDialog other: T) where T : AboutDialogProtocol
Parameters
other
an instance of a related type that implements
AboutDialogProtocol
-
Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
AboutDialogProtocol
.Declaration
Swift
@inlinable override public init<T>(cPointer p: UnsafeMutablePointer<T>)
Parameters
cPointer
pointer to the underlying object
-
Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
AboutDialogProtocol
.Declaration
Swift
@inlinable override public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)
Parameters
cPointer
pointer to the underlying object
-
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
AboutDialogProtocol
.Declaration
Swift
@inlinable override public init(raw p: UnsafeRawPointer)
Parameters
p
raw pointer to the underlying object
-
Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
AboutDialogProtocol
.Declaration
Swift
@inlinable override public init(retainingRaw raw: UnsafeRawPointer)
-
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
AboutDialogProtocol
.Declaration
Swift
@inlinable public required init(raw p: UnsafeMutableRawPointer)
Parameters
p
mutable raw pointer to the underlying object
-
Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
AboutDialogProtocol
.Declaration
Swift
@inlinable required public init(retainingRaw raw: UnsafeMutableRawPointer)
Parameters
raw
mutable raw pointer to the underlying object
-
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
AboutDialogProtocol
.Declaration
Swift
@inlinable override public init(opaquePointer p: OpaquePointer)
Parameters
p
opaque pointer to the underlying object
-
Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
AboutDialogProtocol
.Declaration
Swift
@inlinable override public init(retainingOpaquePointer p: OpaquePointer)
Parameters
p
opaque pointer to the underlying object
-
Creates a new
GtkAboutDialog
.Declaration
Swift
@inlinable override public init()