AboutDialogProtocol

public protocol AboutDialogProtocol : DialogProtocol

The GtkAboutDialog offers a simple way to display information about a program like its 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 gtk_show_uri_on_window() when a user clicks one. The behaviour can be overridden with the GtkAboutDialog::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 http://www.gtk.org”.

To make constructing a GtkAboutDialog as convenient as possible, you can use the function 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: (C Language Example):

GdkPixbuf *example_logo = gdk_pixbuf_new_from_file ("./logo.png", NULL);
gtk_show_about_dialog (NULL,
                       "program-name", "ExampleCode",
                       "logo", example_logo,
                       "title", _("About ExampleCode"),
                       NULL);

It is also possible to show a GtkAboutDialog like any other GtkDialog, e.g. using gtk_dialog_run(). In this case, you might need to know that the “Close” button returns the GTK_RESPONSE_CANCEL response id.

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.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkAboutDialog instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • about_dialog_ptr Default implementation

    Typed 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 }
    Show on GitHub

  • Required Initialiser for types conforming to AboutDialogProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

AboutDialog Class

  • 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 transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • 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

    Show on GitHub
  • set(property:value:) Extension method

    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

    Show on GitHub

AboutDialog signals

  • Connect a Swift signal handler to the given, typed AboutDialogSignalName signal

    Declaration

    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 by userData
    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)

    Show on GitHub

  • Connect a C signal handler to the given, typed AboutDialogSignalName signal

    Declaration

    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 by userData
    signalHandler

    The C function to be called on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • The signal which gets emitted to activate a URI. Applications may connect to it to override the default behaviour, which is to call gtk_show_uri_on_window().

    Note

    This represents the underlying activate-link signal

    Declaration

    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 the activateLink signal is emitted
    Show on GitHub
  • activateLinkSignal Extension method

    Typed activate-link signal for using the connect(signal:) methods

    Declaration

    Swift

    static var activateLinkSignal: AboutDialogSignalName { get }
    Show on GitHub

  • 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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::artists signal

    Declaration

    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
    Show on GitHub
  • notifyArtistsSignal Extension method

    Typed notify::artists signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyArtistsSignal: AboutDialogSignalName { get }
    Show on GitHub

  • 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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::authors signal

    Declaration

    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
    Show on GitHub
  • notifyAuthorsSignal Extension method

    Typed notify::authors signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAuthorsSignal: AboutDialogSignalName { get }
    Show on GitHub

  • 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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::comments signal

    Declaration

    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
    Show on GitHub
  • notifyCommentsSignal Extension method

    Typed notify::comments signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyCommentsSignal: AboutDialogSignalName { get }
    Show on GitHub

  • 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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::copyright signal

    Declaration

    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
    Show on GitHub
  • notifyCopyrightSignal Extension method

    Typed notify::copyright signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyCopyrightSignal: AboutDialogSignalName { get }
    Show on GitHub

  • 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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::documenters signal

    Declaration

    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
    Show on GitHub
  • notifyDocumentersSignal Extension method

    Typed notify::documenters signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyDocumentersSignal: AboutDialogSignalName { get }
    Show on GitHub

  • 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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::license signal

    Declaration

    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
    Show on GitHub
  • notifyLicenseSignal Extension method

    Typed notify::license signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyLicenseSignal: AboutDialogSignalName { get }
    Show on GitHub

  • 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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::license-type signal

    Declaration

    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
    Show on GitHub
  • notifyLicenseTypeSignal Extension method

    Typed notify::license-type signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyLicenseTypeSignal: AboutDialogSignalName { get }
    Show on GitHub
  • onNotifyLogo(flags:handler:) Extension method

    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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::logo signal

    Declaration

    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
    Show on GitHub
  • notifyLogoSignal Extension method

    Typed notify::logo signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyLogoSignal: AboutDialogSignalName { get }
    Show on GitHub

  • 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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::logo-icon-name signal

    Declaration

    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
    Show on GitHub
  • notifyLogoIconNameSignal Extension method

    Typed notify::logo-icon-name signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyLogoIconNameSignal: AboutDialogSignalName { get }
    Show on GitHub

  • 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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::program-name signal

    Declaration

    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
    Show on GitHub
  • notifyProgramNameSignal Extension method

    Typed notify::program-name signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyProgramNameSignal: AboutDialogSignalName { get }
    Show on GitHub

  • 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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::translator-credits signal

    Declaration

    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
    Show on GitHub

  • Typed notify::translator-credits signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyTranslatorCreditsSignal: AboutDialogSignalName { get }
    Show on GitHub

  • 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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::version signal

    Declaration

    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
    Show on GitHub
  • notifyVersionSignal Extension method

    Typed notify::version signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyVersionSignal: AboutDialogSignalName { get }
    Show on GitHub

  • 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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::website signal

    Declaration

    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
    Show on GitHub
  • notifyWebsiteSignal Extension method

    Typed notify::website signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyWebsiteSignal: AboutDialogSignalName { get }
    Show on GitHub

  • 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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::website-label signal

    Declaration

    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
    Show on GitHub
  • notifyWebsiteLabelSignal Extension method

    Typed notify::website-label signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyWebsiteLabelSignal: AboutDialogSignalName { get }
    Show on GitHub

  • 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 to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_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 underlying notify::wrap-license signal

    Declaration

    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
    Show on GitHub
  • notifyWrapLicenseSignal Extension method

    Typed notify::wrap-license signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyWrapLicenseSignal: AboutDialogSignalName { get }
    Show on GitHub

AboutDialog Class: AboutDialogProtocol extension (methods and fields)

  • Creates a new section in the Credits page.

    Declaration

    Swift

    @inlinable
func addCreditSection(sectionName: UnsafePointer<gchar>!, people: UnsafeMutablePointer<UnsafePointer<gchar>?>!)
    Show on GitHub
  • getArtists() Extension method

    Returns the string which are displayed in the artists tab of the secondary credits dialog.

    Declaration

    Swift

    @inlinable
func getArtists() -> UnsafePointer<UnsafePointer<gchar>?>!
    Show on GitHub
  • getAuthors() Extension method

    Returns the string which are displayed in the authors tab of the secondary credits dialog.

    Declaration

    Swift

    @inlinable
func getAuthors() -> UnsafePointer<UnsafePointer<gchar>?>!
    Show on GitHub
  • getComments() Extension method

    Returns the comments string.

    Declaration

    Swift

    @inlinable
func getComments() -> String!
    Show on GitHub
  • getCopyright() Extension method

    Returns the copyright string.

    Declaration

    Swift

    @inlinable
func getCopyright() -> String!
    Show on GitHub
  • getDocumenters() Extension method

    Returns the string which are displayed in the documenters tab of the secondary credits dialog.

    Declaration

    Swift

    @inlinable
func getDocumenters() -> UnsafePointer<UnsafePointer<gchar>?>!
    Show on GitHub
  • getLicense() Extension method

    Returns the license information.

    Declaration

    Swift

    @inlinable
func getLicense() -> String!
    Show on GitHub
  • getLicenseType() Extension method

    Retrieves the license set using gtk_about_dialog_set_license_type()

    Declaration

    Swift

    @inlinable
func getLicenseType() -> GtkLicense
    Show on GitHub
  • getLogo() Extension method

    Returns the pixbuf displayed as logo in the about dialog.

    Declaration

    Swift

    @inlinable
func getLogo() -> PixbufRef!
    Show on GitHub
  • getLogoIconName() Extension method

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

    Declaration

    Swift

    @inlinable
func getLogoIconName() -> String!
    Show on GitHub
  • getProgramName() Extension method

    Returns the program name displayed in the about dialog.

    Declaration

    Swift

    @inlinable
func getProgramName() -> String!
    Show on GitHub
  • getTranslatorCredits() Extension method

    Returns the translator credits string which is displayed in the translators tab of the secondary credits dialog.

    Declaration

    Swift

    @inlinable
func getTranslatorCredits() -> String!
    Show on GitHub
  • getVersion() Extension method

    Returns the version string.

    Declaration

    Swift

    @inlinable
func getVersion() -> String!
    Show on GitHub
  • getWebsite() Extension method

    Returns the website URL.

    Declaration

    Swift

    @inlinable
func getWebsite() -> String!
    Show on GitHub
  • getWebsiteLabel() Extension method

    Returns the label used for the website link.

    Declaration

    Swift

    @inlinable
func getWebsiteLabel() -> String!
    Show on GitHub
  • getWrapLicense() Extension method

    Returns whether the license text in about is automatically wrapped.

    Declaration

    Swift

    @inlinable
func getWrapLicense() -> Bool
    Show on GitHub
  • set(artists:) Extension method

    Sets the strings which are displayed in the artists tab of the secondary credits dialog.

    Declaration

    Swift

    @inlinable
func set(artists: UnsafeMutablePointer<UnsafePointer<gchar>?>!)
    Show on GitHub
  • set(authors:) Extension method

    Sets the strings which are displayed in the authors tab of the secondary credits dialog.

    Declaration

    Swift

    @inlinable
func set(authors: UnsafeMutablePointer<UnsafePointer<gchar>?>!)
    Show on GitHub
  • 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<gchar>? = nil)
    Show on GitHub
  • 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<gchar>? = nil)
    Show on GitHub
  • set(documenters:) Extension method

    Sets the strings which are displayed in the documenters tab of the secondary credits dialog.

    Declaration

    Swift

    @inlinable
func set(documenters: UnsafeMutablePointer<UnsafePointer<gchar>?>!)
    Show on GitHub
  • set(license:) Extension method

    Sets the license information to be displayed in the secondary license dialog. If license is nil, the license button is hidden.

    Declaration

    Swift

    @inlinable
func set(license: UnsafePointer<gchar>? = nil)
    Show on GitHub
  • 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 gtk_about_dialog_set_license().

    Declaration

    Swift

    @inlinable
func set(licenseType: GtkLicense)
    Show on GitHub
  • set(logo:) Extension method

    Sets the pixbuf to be displayed as logo in the about dialog. If it is nil, the default window icon set with gtk_window_set_default_icon() will be used.

    Declaration

    Swift

    @inlinable
func set(logo: PixbufRef? = nil)
    Show on GitHub
  • set(logo:) Extension method

    Sets the pixbuf to be displayed as logo in the about dialog. If it is nil, the default window icon set with gtk_window_set_default_icon() will be used.

    Declaration

    Swift

    @inlinable
func set<PixbufT>(logo: PixbufT?) where PixbufT : PixbufProtocol
    Show on GitHub
  • setLogo(iconName:) Extension method

    Sets the pixbuf to be displayed as logo in the about dialog. If it is nil, the default window icon set with gtk_window_set_default_icon() will be used.

    Declaration

    Swift

    @inlinable
func setLogo(iconName: UnsafePointer<gchar>? = nil)
    Show on GitHub
  • setProgram(name:) Extension method

    Sets the name to display in the about dialog. If this is not set, it defaults to g_get_application_name().

    Declaration

    Swift

    @inlinable
func setProgram(name: UnsafePointer<gchar>!)
    Show on GitHub
  • set(translatorCredits:) Extension method

    Sets the translator credits string which is displayed in the translators tab of the secondary credits dialog.

    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 Language Example):

    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 hide the tab.

    Declaration

    Swift

    @inlinable
func set(translatorCredits: UnsafePointer<gchar>? = nil)
    Show on GitHub
  • set(version:) Extension method

    Sets the version string to display in the about dialog.

    Declaration

    Swift

    @inlinable
func set(version: UnsafePointer<gchar>? = nil)
    Show on GitHub
  • set(website:) Extension method

    Sets the URL to use for the website link.

    Declaration

    Swift

    @inlinable
func set(website: UnsafePointer<gchar>? = nil)
    Show on GitHub
  • set(websiteLabel:) Extension method

    Sets the label to be used for the website link.

    Declaration

    Swift

    @inlinable
func set(websiteLabel: UnsafePointer<gchar>!)
    Show on GitHub
  • set(wrapLicense:) Extension method

    Sets whether the license text in about is automatically wrapped.

    Declaration

    Swift

    @inlinable
func set(wrapLicense: Bool)
    Show on GitHub
  • artists Extension method

    The people who contributed artwork to the program, as a nil-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 artists: UnsafePointer<UnsafePointer<gchar>?>! { get nonmutating set }
    Show on GitHub
  • authors Extension method

    The authors of the program, as a nil-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<gchar>?>! { get nonmutating set }
    Show on GitHub
  • comments Extension method

    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.

    Declaration

    Swift

    @inlinable
var comments: String! { get nonmutating set }
    Show on GitHub
  • copyright Extension method

    Copyright information for the program.

    Declaration

    Swift

    @inlinable
var copyright: String! { get nonmutating set }
    Show on GitHub
  • documenters Extension method

    The people documenting the program, as a nil-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<gchar>?>! { get nonmutating set }
    Show on GitHub
  • license Extension method

    The license of the program. 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-nil value, the GtkAboutDialog:license-type property is set to GTK_LICENSE_CUSTOM as a side effect.

    Declaration

    Swift

    @inlinable
var license: String! { get nonmutating set }
    Show on GitHub
  • licenseType Extension method

    Retrieves the license set using gtk_about_dialog_set_license_type()

    Declaration

    Swift

    @inlinable
var licenseType: GtkLicense { get nonmutating set }
    Show on GitHub
  • logo Extension method

    A logo for the about box. If it is nil, the default window icon set with gtk_window_set_default_icon() will be used.

    Declaration

    Swift

    @inlinable
var logo: PixbufRef! { get nonmutating set }
    Show on GitHub
  • logoIconName Extension method

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

    Declaration

    Swift

    @inlinable
var logoIconName: String! { get nonmutating set }
    Show on GitHub
  • programName Extension method

    Returns the program name displayed in the about dialog.

    Declaration

    Swift

    @inlinable
var programName: String! { get nonmutating set }
    Show on GitHub
  • translatorCredits Extension method

    Returns the translator credits string which is displayed in the translators tab of the secondary credits dialog.

    Declaration

    Swift

    @inlinable
var translatorCredits: String! { get nonmutating set }
    Show on GitHub
  • version Extension method

    The version of the program.

    Declaration

    Swift

    @inlinable
var version: String! { get nonmutating set }
    Show on GitHub
  • website Extension method

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

    Declaration

    Swift

    @inlinable
var website: String! { get nonmutating set }
    Show on GitHub
  • websiteLabel Extension method

    Returns the label used for the website link.

    Declaration

    Swift

    @inlinable
var websiteLabel: String! { get nonmutating set }
    Show on GitHub
  • wrapLicense Extension method

    Returns whether the license text in about is automatically wrapped.

    Declaration

    Swift

    @inlinable
var wrapLicense: Bool { get nonmutating set }
    Show on GitHub
  • parentInstance Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var parentInstance: GtkDialog { get }
    Show on GitHub