AppChooserButtonProtocol

public protocol AppChooserButtonProtocol : AppChooserProtocol

The GtkAppChooserButton lets the user select an application.

An example GtkAppChooserButton

Initially, a GtkAppChooserButton selects the first application in its list, which will either be the most-recently used application or, if [propertyGtk.AppChooserButton:show-default-item] is true, the default application.

The list of applications shown in a GtkAppChooserButton includes the recommended applications for the given content type. When [propertyGtk.AppChooserButton:show-default-item] is set, the default application is also included. To let the user chooser other applications, you can set the [propertyGtk.AppChooserButton:show-dialog-item] property, which allows to open a full [classGtk.AppChooserDialog].

It is possible to add custom items to the list, using [methodGtk.AppChooserButton.append_custom_item]. These items cause the [signalGtk.AppChooserButton::custom-item-activated] signal to be emitted when they are selected.

To track changes in the selected application, use the [signalGtk.AppChooserButton::changed] signal.

CSS nodes

GtkAppChooserButton has a single CSS node with the name “appchooserbutton”.

The AppChooserButtonProtocol protocol exposes the methods and properties of an underlying GtkAppChooserButton 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 AppChooserButton. Alternatively, use AppChooserButtonRef 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 GtkAppChooserButton instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkAppChooserButton instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkAppChooserButton instance.

    Declaration

    Swift

    var app_chooser_button_ptr: UnsafeMutablePointer<GtkAppChooserButton>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to AppChooserButtonProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

AppChooserButton Class

  • Bind a AppChooserButtonPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: AppChooserButtonPropertyName, 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 AppChooserButton property

    Declaration

    Swift

    @inlinable
func get(property: AppChooserButtonPropertyName) -> 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 AppChooserButton property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: AppChooserButtonPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

AppChooserButton signals

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

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: AppChooserButtonSignalName, 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 AppChooserButtonSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: AppChooserButtonSignalName, 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
  • onActivate(flags:handler:) Extension method

    Emitted to when the button is activated.

    The activate signal on GtkAppChooserButton is an action signal and emitting it causes the button to pop up its dialog.

    Note

    This represents the underlying activate signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onActivate(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AppChooserButtonRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the activate signal is emitted
    Show on GitHub
  • activateSignal Extension method

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

    Declaration

    Swift

    static var activateSignal: AppChooserButtonSignalName { get }
    Show on GitHub
  • onChanged(flags:handler:) Extension method

    Emitted when the active application changes.

    Note

    This represents the underlying changed signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onChanged(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AppChooserButtonRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the changed signal is emitted
    Show on GitHub
  • changedSignal Extension method

    Typed changed signal for using the connect(signal:) methods

    Declaration

    Swift

    static var changedSignal: AppChooserButtonSignalName { get }
    Show on GitHub

  • Emitted when a custom item is activated.

    Use [methodGtk.AppChooserButton.append_custom_item], to add custom items.

    Note

    This represents the underlying custom-item-activated signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onCustomItemActivated(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AppChooserButtonRef, _ itemName: String) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    itemName

    the name of the activated item
    handler

    The signal handler to call Run the given callback whenever the customItemActivated signal is emitted
    Show on GitHub
  • customItemActivatedSignal Extension method

    Typed custom-item-activated signal for using the connect(signal:) methods

    Declaration

    Swift

    static var customItemActivatedSignal: AppChooserButtonSignalName { 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::heading signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyHeading(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AppChooserButtonRef, _ 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 notifyHeading signal is emitted
    Show on GitHub
  • notifyHeadingSignal Extension method

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

    Declaration

    Swift

    static var notifyHeadingSignal: AppChooserButtonSignalName { 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::modal signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyModal(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AppChooserButtonRef, _ 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 notifyModal signal is emitted
    Show on GitHub
  • notifyModalSignal Extension method

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

    Declaration

    Swift

    static var notifyModalSignal: AppChooserButtonSignalName { 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::show-default-item signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyShowDefaultItem(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AppChooserButtonRef, _ 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 notifyShowDefaultItem signal is emitted
    Show on GitHub
  • notifyShowDefaultItemSignal Extension method

    Typed notify::show-default-item signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyShowDefaultItemSignal: AppChooserButtonSignalName { 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::show-dialog-item signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyShowDialogItem(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AppChooserButtonRef, _ 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 notifyShowDialogItem signal is emitted
    Show on GitHub
  • notifyShowDialogItemSignal Extension method

    Typed notify::show-dialog-item signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyShowDialogItemSignal: AppChooserButtonSignalName { get }
    Show on GitHub

AppChooserButton Class: AppChooserButtonProtocol extension (methods and fields)

  • Appends a custom item to the list of applications that is shown in the popup.

    The item name must be unique per-widget. Clients can use the provided name as a detail for the [signalGtk.AppChooserButton::custom-item-activated] signal, to add a callback for the activation of a particular custom item in the list.

    See also [methodGtk.AppChooserButton.append_separator].

    Declaration

    Swift

    @inlinable
func appendCustomItem<IconT>(name: UnsafePointer<CChar>!, label: UnsafePointer<CChar>!, icon: IconT) where IconT : IconProtocol
    Show on GitHub
  • appendSeparator() Extension method

    Appends a separator to the list of applications that is shown in the popup.

    Declaration

    Swift

    @inlinable
func appendSeparator()
    Show on GitHub
  • getHeading() Extension method

    Returns the text to display at the top of the dialog.

    Declaration

    Swift

    @inlinable
func getHeading() -> String!
    Show on GitHub
  • getModal() Extension method

    Gets whether the dialog is modal.

    Declaration

    Swift

    @inlinable
func getModal() -> Bool
    Show on GitHub
  • getShowDefaultItem() Extension method

    Returns whether the dropdown menu should show the default application at the top.

    Declaration

    Swift

    @inlinable
func getShowDefaultItem() -> Bool
    Show on GitHub
  • getShowDialogItem() Extension method

    Returns whether the dropdown menu shows an item for a GtkAppChooserDialog.

    Declaration

    Swift

    @inlinable
func getShowDialogItem() -> Bool
    Show on GitHub
  • setActiveCustomItem(name:) Extension method

    Selects a custom item.

    See [methodGtk.AppChooserButton.append_custom_item].

    Use [methodGtk.AppChooser.refresh] to bring the selection to its initial state.

    Declaration

    Swift

    @inlinable
func setActiveCustomItem(name: UnsafePointer<CChar>!)
    Show on GitHub
  • set(heading:) Extension method

    Sets the text to display at the top of the dialog.

    If the heading is not set, the dialog displays a default text.

    Declaration

    Swift

    @inlinable
func set(heading: UnsafePointer<CChar>!)
    Show on GitHub
  • set(modal:) Extension method

    Sets whether the dialog should be modal.

    Declaration

    Swift

    @inlinable
func set(modal: Bool)
    Show on GitHub
  • setShowDefaultItem(setting:) Extension method

    Sets whether the dropdown menu of this button should show the default application for the given content type at top.

    Declaration

    Swift

    @inlinable
func setShowDefaultItem(setting: Bool)
    Show on GitHub
  • setShowDialogItem(setting:) Extension method

    Sets whether the dropdown menu of this button should show an entry to trigger a GtkAppChooserDialog.

    Declaration

    Swift

    @inlinable
func setShowDialogItem(setting: Bool)
    Show on GitHub
  • heading Extension method

    The text to show at the top of the dialog that can be opened from the button.

    The string may contain Pango markup.

    Declaration

    Swift

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

    Whether the app chooser dialog should be modal.

    Declaration

    Swift

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

    Returns whether the dropdown menu should show the default application at the top.

    Declaration

    Swift

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

    Returns whether the dropdown menu shows an item for a GtkAppChooserDialog.

    Declaration

    Swift

    @inlinable
var showDialogItem: Bool { get nonmutating set }
    Show on GitHub