AppChooserButtonProtocol

public protocol AppChooserButtonProtocol : AppChooserProtocol, ComboBoxProtocol

The GtkAppChooserButton is a widget that lets the user select an application. It implements the GtkAppChooser interface.

Initially, a GtkAppChooserButton selects the first application in its list, which will either be the most-recently used application or, if GtkAppChooserButton: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 GtkAppChooserButton:show-default-item is set, the default application is also included. To let the user chooser other applications, you can set the GtkAppChooserButton:show-dialog-item property, which allows to open a full GtkAppChooserDialog.

It is possible to add custom items to the list, using gtk_app_chooser_button_append_custom_item(). These items cause the GtkAppChooserButton::custom-item-activated signal to be emitted when they are selected.

To track changes in the selected application, use the GtkComboBox::changed signal.

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.

  • ptr

    Untyped pointer to the underlying GtkAppChooserButton instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
  • 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 }
  • Required Initialiser for types conforming to AppChooserButtonProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)

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

  • 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

  • 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

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)

  • 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)

  • Emitted when a custom item, previously added with gtk_app_chooser_button_append_custom_item(), is activated from the dropdown menu.

    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

  • customItemActivatedSignal Extension method

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

    Declaration

    Swift

    static var customItemActivatedSignal: AppChooserButtonSignalName { get }
  • 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

  • notifyHeadingSignal Extension method

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

    Declaration

    Swift

    static var notifyHeadingSignal: AppChooserButtonSignalName { get }
  • 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

  • notifyShowDefaultItemSignal Extension method

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

    Declaration

    Swift

    static var notifyShowDefaultItemSignal: AppChooserButtonSignalName { get }
  • 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

  • notifyShowDialogItemSignal Extension method

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

    Declaration

    Swift

    static var notifyShowDialogItemSignal: AppChooserButtonSignalName { get }

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 GtkAppChooserButton::custom-item-activated signal, to add a callback for the activation of a particular custom item in the list. See also gtk_app_chooser_button_append_separator().

    Declaration

    Swift

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

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

    Declaration

    Swift

    @inlinable
    func appendSeparator()
  • getHeading() Extension method

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

    Declaration

    Swift

    @inlinable
    func getHeading() -> String!
  • getShowDefaultItem() Extension method

    Returns the current value of the GtkAppChooserButton:show-default-item property.

    Declaration

    Swift

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

    Returns the current value of the GtkAppChooserButton:show-dialog-item property.

    Declaration

    Swift

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

    Selects a custom item previously added with gtk_app_chooser_button_append_custom_item().

    Use gtk_app_chooser_refresh() to bring the selection to its initial state.

    Declaration

    Swift

    @inlinable
    func setActiveCustomItem(name: UnsafePointer<gchar>!)
  • 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<gchar>!)
  • 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)
  • 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)
  • 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 }
  • showDefaultItem Extension method

    Returns the current value of the GtkAppChooserButton:show-default-item property.

    Declaration

    Swift

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

    Returns the current value of the GtkAppChooserButton:show-dialog-item property.

    Declaration

    Swift

    @inlinable
    var showDialogItem: Bool { get nonmutating set }
  • parent Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
    var parent: GtkComboBox { get }