AboutDialogProtocol
public protocol AboutDialogProtocol : WindowProtocol
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 AboutDialogProtocol
protocol exposes the methods and properties of an underlying GtkAboutDialog
instance.
The default implementation of these can be found in the protocol extension below.
For a concrete class that implements these methods and properties, see AboutDialog
.
Alternatively, use AboutDialogRef
as a lighweight, unowned
reference if you already have an instance you just want to use.
-
Untyped pointer to the underlying
GtkAboutDialog
instance.Declaration
Swift
var ptr: UnsafeMutableRawPointer! { get }
-
about_dialog_ptr
Default implementationTyped pointer to the underlying
GtkAboutDialog
instance.Default Implementation
Return the stored, untyped pointer as a typed pointer to the
GtkAboutDialog
instance.Declaration
Swift
var about_dialog_ptr: UnsafeMutablePointer<GtkAboutDialog>! { get }
-
Required Initialiser for types conforming to
AboutDialogProtocol
Declaration
Swift
init(raw: UnsafeMutableRawPointer)
-
bind(property:
Extension methodto: _: flags: transformFrom: transformTo: ) Bind a
AboutDialogPropertyName
source property to a given target object.Declaration
Swift
@discardableResult @inlinable func bind<Q, T>(property source_property: AboutDialogPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol
Parameters
source_property
the source property to bind
target
the target object to bind to
target_property
the target property to bind to
flags
the flags to pass to the
Binding
transform_from
ValueTransformer
to use for forward transformationtransform_to
ValueTransformer
to use for backwards transformationReturn Value
binding reference or
nil
in case of an error -
get(property:
Extension method) Get the value of a AboutDialog property
Declaration
Swift
@inlinable func get(property: AboutDialogPropertyName) -> GLibObject.Value
Parameters
property
the property to get the value for
Return Value
the value of the named property
-
set(property:
Extension methodvalue: ) Set the value of a AboutDialog property. Note that this will only have an effect on properties that are writable and not construct-only!
Declaration
Swift
@inlinable func set(property: AboutDialogPropertyName, value v: GLibObject.Value)
Parameters
property
the property to get the value for
Return Value
the value of the named property
-
connect(signal:
Extension methodflags: handler: ) Connect a Swift signal handler to the given, typed
AboutDialogSignalName
signalDeclaration
Swift
@discardableResult @inlinable func connect(signal s: AboutDialogSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int
Parameters
signal
The signal to connect
flags
The connection flags to use
data
A pointer to user data to provide to the callback
destroyData
A
GClosureNotify
C function to destroy the data pointed to byuserData
handler
The Swift signal handler (function or callback) to invoke on the given signal
Return Value
The signal handler ID (always greater than 0 for successful connections)
-
connect(signal:
Extension methodflags: data: destroyData: signalHandler: ) Connect a C signal handler to the given, typed
AboutDialogSignalName
signalDeclaration
Swift
@discardableResult @inlinable func connect(signal s: AboutDialogSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int
Parameters
signal
The signal to connect
flags
The connection flags to use
data
A pointer to user data to provide to the callback
destroyData
A
GClosureNotify
C function to destroy the data pointed to byuserData
signalHandler
The C function to be called on the given signal
Return Value
The signal handler ID (always greater than 0 for successful connections)
-
onActivateLink(flags:
Extension methodhandler: ) Emitted every time a URL is activated.
Applications may connect to it to override the default behaviour, which is to call [func
Gtk.show_uri
].Note
This represents the underlyingactivate-link
signalDeclaration
Swift
@discardableResult @inlinable func onActivateLink(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ uri: String) -> Bool) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
uri
the URI that is activated
handler
TRUE
if the link has been activated Run the given callback whenever theactivateLink
signal is emitted -
activateLinkSignal
Extension methodTyped
activate-link
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var activateLinkSignal: AboutDialogSignalName { get }
-
onNotifyArtists(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::artists
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyArtists(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyArtists
signal is emitted -
notifyArtistsSignal
Extension methodTyped
notify::artists
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyArtistsSignal: AboutDialogSignalName { get }
-
onNotifyAuthors(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::authors
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyAuthors(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyAuthors
signal is emitted -
notifyAuthorsSignal
Extension methodTyped
notify::authors
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAuthorsSignal: AboutDialogSignalName { get }
-
onNotifyComments(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::comments
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyComments(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyComments
signal is emitted -
notifyCommentsSignal
Extension methodTyped
notify::comments
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyCommentsSignal: AboutDialogSignalName { get }
-
onNotifyCopyright(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::copyright
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyCopyright(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyCopyright
signal is emitted -
notifyCopyrightSignal
Extension methodTyped
notify::copyright
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyCopyrightSignal: AboutDialogSignalName { get }
-
onNotifyDocumenters(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::documenters
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyDocumenters(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyDocumenters
signal is emitted -
notifyDocumentersSignal
Extension methodTyped
notify::documenters
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyDocumentersSignal: AboutDialogSignalName { get }
-
onNotifyLicense(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::license
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyLicense(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyLicense
signal is emitted -
notifyLicenseSignal
Extension methodTyped
notify::license
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyLicenseSignal: AboutDialogSignalName { get }
-
onNotifyLicenseType(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::license-type
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyLicenseType(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyLicenseType
signal is emitted -
notifyLicenseTypeSignal
Extension methodTyped
notify::license-type
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyLicenseTypeSignal: AboutDialogSignalName { get }
-
onNotifyLogo(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::logo
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyLogo(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyLogo
signal is emitted -
notifyLogoSignal
Extension methodTyped
notify::logo
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyLogoSignal: AboutDialogSignalName { get }
-
onNotifyLogoIconName(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::logo-icon-name
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyLogoIconName(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyLogoIconName
signal is emitted -
notifyLogoIconNameSignal
Extension methodTyped
notify::logo-icon-name
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyLogoIconNameSignal: AboutDialogSignalName { get }
-
onNotifyProgramName(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::program-name
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyProgramName(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyProgramName
signal is emitted -
notifyProgramNameSignal
Extension methodTyped
notify::program-name
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyProgramNameSignal: AboutDialogSignalName { get }
-
onNotifySystemInformation(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::system-information
signalDeclaration
Swift
@discardableResult @inlinable func onNotifySystemInformation(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifySystemInformation
signal is emitted -
notifySystemInformationSignal
Extension methodTyped
notify::system-information
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifySystemInformationSignal: AboutDialogSignalName { get }
-
onNotifyTranslatorCredits(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::translator-credits
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyTranslatorCredits(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyTranslatorCredits
signal is emitted -
notifyTranslatorCreditsSignal
Extension methodTyped
notify::translator-credits
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyTranslatorCreditsSignal: AboutDialogSignalName { get }
-
onNotifyVersion(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::version
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyVersion(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyVersion
signal is emitted -
notifyVersionSignal
Extension methodTyped
notify::version
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyVersionSignal: AboutDialogSignalName { get }
-
onNotifyWebsite(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::website
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyWebsite(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyWebsite
signal is emitted -
notifyWebsiteSignal
Extension methodTyped
notify::website
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyWebsiteSignal: AboutDialogSignalName { get }
-
onNotifyWebsiteLabel(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::website-label
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyWebsiteLabel(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyWebsiteLabel
signal is emitted -
notifyWebsiteLabelSignal
Extension methodTyped
notify::website-label
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyWebsiteLabelSignal: AboutDialogSignalName { get }
-
onNotifyWrapLicense(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::wrap-license
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyWrapLicense(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AboutDialogRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyWrapLicense
signal is emitted -
notifyWrapLicenseSignal
Extension methodTyped
notify::wrap-license
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyWrapLicenseSignal: AboutDialogSignalName { get }
-
addCreditSection(sectionName:
Extension methodpeople: ) Creates a new section in the “Credits” page.
Declaration
Swift
@inlinable func addCreditSection(sectionName: UnsafePointer<CChar>!, people: UnsafeMutablePointer<UnsafePointer<CChar>?>!)
-
getArtists()
Extension methodReturns the names of the artists which are displayed in the credits page.
Declaration
Swift
@inlinable func getArtists() -> UnsafePointer<UnsafePointer<CChar>?>!
-
getAuthors()
Extension methodReturns the names of the authors which are displayed in the credits page.
Declaration
Swift
@inlinable func getAuthors() -> UnsafePointer<UnsafePointer<CChar>?>!
-
getComments()
Extension methodReturns the comments string.
Declaration
Swift
@inlinable func getComments() -> String!
-
getCopyright()
Extension methodReturns the copyright string.
Declaration
Swift
@inlinable func getCopyright() -> String!
-
getDocumenters()
Extension methodReturns the name of the documenters which are displayed in the credits page.
Declaration
Swift
@inlinable func getDocumenters() -> UnsafePointer<UnsafePointer<CChar>?>!
-
getLicense()
Extension methodReturns the license information.
Declaration
Swift
@inlinable func getLicense() -> String!
-
getLicenseType()
Extension methodRetrieves the license type.
Declaration
Swift
@inlinable func getLicenseType() -> GtkLicense
-
getLogo()
Extension methodReturns the paintable displayed as logo in the about dialog.
Declaration
Swift
@inlinable func getLogo() -> Gdk.PaintableRef!
-
getLogoIconName()
Extension methodReturns the icon name displayed as logo in the about dialog.
Declaration
Swift
@inlinable func getLogoIconName() -> String!
-
getProgramName()
Extension methodReturns the program name displayed in the about dialog.
Declaration
Swift
@inlinable func getProgramName() -> String!
-
getSystemInformation()
Extension methodReturns the system information that is shown in the about dialog.
Declaration
Swift
@inlinable func getSystemInformation() -> String!
-
getTranslatorCredits()
Extension methodReturns the translator credits string which is displayed in the credits page.
Declaration
Swift
@inlinable func getTranslatorCredits() -> String!
-
getVersion()
Extension methodReturns the version string.
Declaration
Swift
@inlinable func getVersion() -> String!
-
getWebsite()
Extension methodReturns the website URL.
Declaration
Swift
@inlinable func getWebsite() -> String!
-
getWebsiteLabel()
Extension methodReturns the label used for the website link.
Declaration
Swift
@inlinable func getWebsiteLabel() -> String!
-
getWrapLicense()
Extension methodReturns whether the license text in the about dialog is automatically wrapped.
Declaration
Swift
@inlinable func getWrapLicense() -> Bool
-
set(artists:
Extension method) Sets the names of the artists to be displayed in the “Credits” page.
Declaration
Swift
@inlinable func set(artists: UnsafeMutablePointer<UnsafePointer<CChar>?>!)
-
set(authors:
Extension method) Sets the names of the authors which are displayed in the “Credits” page of the about dialog.
Declaration
Swift
@inlinable func set(authors: UnsafeMutablePointer<UnsafePointer<CChar>?>!)
-
set(comments:
Extension method) Sets the comments string to display in the about dialog.
This should be a short string of one or two lines.
Declaration
Swift
@inlinable func set(comments: UnsafePointer<CChar>? = nil)
-
set(copyright:
Extension method) Sets the copyright string to display in the about dialog.
This should be a short string of one or two lines.
Declaration
Swift
@inlinable func set(copyright: UnsafePointer<CChar>? = nil)
-
set(documenters:
Extension method) Sets the names of the documenters which are displayed in the “Credits” page.
Declaration
Swift
@inlinable func set(documenters: UnsafeMutablePointer<UnsafePointer<CChar>?>!)
-
set(license:
Extension method) Sets the license information to be displayed in the about dialog.
If
license
isNULL
, the license page is hidden.Declaration
Swift
@inlinable func set(license: UnsafePointer<CChar>? = nil)
-
set(licenseType:
Extension method) 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
].Declaration
Swift
@inlinable func set(licenseType: GtkLicense)
-
set(logo:
Extension method) Sets the logo in the about dialog.
Declaration
Swift
@inlinable func set(logo: Gdk.PaintableRef? = nil)
-
set(logo:
Extension method) Sets the logo in the about dialog.
Declaration
Swift
@inlinable func set<PaintableT>(logo: PaintableT?) where PaintableT : PaintableProtocol
-
setLogo(iconName:
Extension method) Sets the icon name to be displayed as logo in the about dialog.
Declaration
Swift
@inlinable func setLogo(iconName: UnsafePointer<CChar>? = nil)
-
setProgram(name:
Extension method) Sets the name to display in the about dialog.
If
name
is not set, the string returned byg_get_application_name()
is used.Declaration
Swift
@inlinable func setProgram(name: UnsafePointer<CChar>? = nil)
-
set(systemInformation:
Extension method) Sets the system information to be displayed in the about dialog.
If
system_information
isNULL
, the system information page is hidden.See [property
Gtk.AboutDialog:system-information
].Declaration
Swift
@inlinable func set(systemInformation: UnsafePointer<CChar>? = nil)
-
set(translatorCredits:
Extension method) 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: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 thatmsgid
, and sinceGtkAboutDialog
will detect if “translator-credits” is untranslated and omit translator credits.Declaration
Swift
@inlinable func set(translatorCredits: UnsafePointer<CChar>? = nil)
-
set(version:
Extension method) Sets the version string to display in the about dialog.
Declaration
Swift
@inlinable func set(version: UnsafePointer<CChar>? = nil)
-
set(website:
Extension method) Sets the URL to use for the website link.
Declaration
Swift
@inlinable func set(website: UnsafePointer<CChar>? = nil)
-
set(websiteLabel:
Extension method) Sets the label to be used for the website link.
Declaration
Swift
@inlinable func set(websiteLabel: UnsafePointer<CChar>!)
-
set(wrapLicense:
Extension method) Sets whether the license text in the about dialog should be automatically wrapped.
Declaration
Swift
@inlinable func set(wrapLicense: Bool)
-
artists
Extension methodThe people who contributed artwork to the program, as a
NULL
-terminated array of strings.Each string may contain email addresses and URLs, which will be displayed as links.
Declaration
Swift
@inlinable var artists: UnsafePointer<UnsafePointer<CChar>?>! { get nonmutating set }
-
authors
Extension methodThe authors of the program, as a
NULL
-terminated array of strings.Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.
Declaration
Swift
@inlinable var authors: UnsafePointer<UnsafePointer<CChar>?>! { get nonmutating set }
-
comments
Extension methodComments 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.
Declaration
Swift
@inlinable var comments: String! { get nonmutating set }
-
copyright
Extension methodCopyright information for the program.
Declaration
Swift
@inlinable var copyright: String! { get nonmutating set }
-
documenters
Extension methodThe people documenting the program, as a
NULL
-terminated array of strings.Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.
Declaration
Swift
@inlinable var documenters: UnsafePointer<UnsafePointer<CChar>?>! { get nonmutating set }
-
license
Extension methodThe 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 [propertyGtk.AboutDialog:license-type
] property is set toGTK_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.Declaration
Swift
@inlinable var license: String! { get nonmutating set }
-
licenseType
Extension methodRetrieves the license type.
Declaration
Swift
@inlinable var licenseType: GtkLicense { get nonmutating set }
-
logo
Extension methodA logo for the about box.
If it is
NULL
, the default window icon set with [idgtk_window_set_default_icon_name
] will be used.Declaration
Swift
@inlinable var logo: Gdk.PaintableRef! { get nonmutating set }
-
logoIconName
Extension methodReturns the icon name displayed as logo in the about dialog.
Declaration
Swift
@inlinable var logoIconName: String! { get nonmutating set }
-
programName
Extension methodReturns the program name displayed in the about dialog.
Declaration
Swift
@inlinable var programName: String! { get nonmutating set }
-
systemInformation
Extension methodReturns the system information that is shown in the about dialog.
Declaration
Swift
@inlinable var systemInformation: String! { get nonmutating set }
-
translatorCredits
Extension methodReturns the translator credits string which is displayed in the credits page.
Declaration
Swift
@inlinable var translatorCredits: String! { get nonmutating set }
-
version
Extension methodThe version of the program.
Declaration
Swift
@inlinable var version: String! { get nonmutating set }
-
website
Extension methodThe URL for the link to the website of the program.
This should be a string starting with
http://
orhttps://
.Declaration
Swift
@inlinable var website: String! { get nonmutating set }
-
websiteLabel
Extension methodReturns the label used for the website link.
Declaration
Swift
@inlinable var websiteLabel: String! { get nonmutating set }
-
wrapLicense
Extension methodReturns whether the license text in the about dialog is automatically wrapped.
Declaration
Swift
@inlinable var wrapLicense: Bool { get nonmutating set }