AppChooserWidgetProtocol

public protocol AppChooserWidgetProtocol : AppChooserProtocol, BoxProtocol

GtkAppChooserWidget is a widget for selecting applications. It is the main building block for GtkAppChooserDialog. Most applications only need to use the latter; but you can use this widget as part of a larger widget if you have special needs.

GtkAppChooserWidget offers detailed control over what applications are shown, using the GtkAppChooserWidget:show-default, GtkAppChooserWidget:show-recommended, GtkAppChooserWidget:show-fallback, GtkAppChooserWidget:show-other and GtkAppChooserWidget:show-all properties. See the GtkAppChooser documentation for more information about these groups of applications.

To keep track of the selected application, use the GtkAppChooserWidget::application-selected and GtkAppChooserWidget::application-activated signals.

CSS nodes

GtkAppChooserWidget has a single CSS node with name appchooser.

The AppChooserWidgetProtocol protocol exposes the methods and properties of an underlying GtkAppChooserWidget 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 AppChooserWidget. Alternatively, use AppChooserWidgetRef 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 GtkAppChooserWidget instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkAppChooserWidget instance.

    Default Implementation

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

    Declaration

    Swift

    var app_chooser_widget_ptr: UnsafeMutablePointer<GtkAppChooserWidget>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to AppChooserWidgetProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

AppChooserWidget Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

AppChooserWidget signals

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

    Declaration

    Swift

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

    Declaration

    Swift

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

  • Emitted when an application item is activated from the widget’s list.

    This usually happens when the user double clicks an item, or an item is selected and the user presses one of the keys Space, Shift+Space, Return or Enter.

    Note

    This represents the underlying application-activated signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onApplicationActivated(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AppChooserWidgetRef, _ application: GIO.AppInfoRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    application

    the activated GAppInfo
    handler

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

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

    Declaration

    Swift

    static var applicationActivatedSignal: AppChooserWidgetSignalName { get }
    Show on GitHub

  • Emitted when an application item is selected from the widget’s list.

    Note

    This represents the underlying application-selected signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onApplicationSelected(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AppChooserWidgetRef, _ application: GIO.AppInfoRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    application

    the selected GAppInfo
    handler

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

    Typed application-selected signal for using the connect(signal:) methods

    Declaration

    Swift

    static var applicationSelectedSignal: AppChooserWidgetSignalName { get }
    Show on GitHub

  • Emitted when a context menu is about to popup over an application item. Clients can insert menu items into the provided GtkMenu object in the callback of this signal; the context menu will be shown over the item if at least one item has been added to the menu.

    Note

    This represents the underlying populate-popup signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onPopulatePopup(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: AppChooserWidgetRef, _ menu: MenuRef, _ application: GIO.AppInfoRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    menu

    the GtkMenu to populate
    application

    the current GAppInfo
    handler

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

    Typed populate-popup signal for using the connect(signal:) methods

    Declaration

    Swift

    static var populatePopupSignal: AppChooserWidgetSignalName { 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::default-text signal

    Declaration

    Swift

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

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

    Declaration

    Swift

    static var notifyDefaultTextSignal: AppChooserWidgetSignalName { 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-all signal

    Declaration

    Swift

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

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

    Declaration

    Swift

    static var notifyShowAllSignal: AppChooserWidgetSignalName { 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 signal

    Declaration

    Swift

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

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

    Declaration

    Swift

    static var notifyShowDefaultSignal: AppChooserWidgetSignalName { 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-fallback signal

    Declaration

    Swift

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

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

    Declaration

    Swift

    static var notifyShowFallbackSignal: AppChooserWidgetSignalName { 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-other signal

    Declaration

    Swift

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

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

    Declaration

    Swift

    static var notifyShowOtherSignal: AppChooserWidgetSignalName { 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-recommended signal

    Declaration

    Swift

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

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

    Declaration

    Swift

    static var notifyShowRecommendedSignal: AppChooserWidgetSignalName { get }
    Show on GitHub

AppChooserWidget Class: AppChooserWidgetProtocol extension (methods and fields)

  • getDefaultText() Extension method

    Returns the text that is shown if there are not applications that can handle the content type.

    Declaration

    Swift

    @inlinable
func getDefaultText() -> String!
    Show on GitHub
  • getShowAll() Extension method

    Returns the current value of the GtkAppChooserWidget:show-all property.

    Declaration

    Swift

    @inlinable
func getShowAll() -> Bool
    Show on GitHub
  • getShowDefault() Extension method

    Returns the current value of the GtkAppChooserWidget:show-default property.

    Declaration

    Swift

    @inlinable
func getShowDefault() -> Bool
    Show on GitHub
  • getShowFallback() Extension method

    Returns the current value of the GtkAppChooserWidget:show-fallback property.

    Declaration

    Swift

    @inlinable
func getShowFallback() -> Bool
    Show on GitHub
  • getShowOther() Extension method

    Returns the current value of the GtkAppChooserWidget:show-other property.

    Declaration

    Swift

    @inlinable
func getShowOther() -> Bool
    Show on GitHub
  • getShowRecommended() Extension method

    Returns the current value of the GtkAppChooserWidget:show-recommended property.

    Declaration

    Swift

    @inlinable
func getShowRecommended() -> Bool
    Show on GitHub
  • setDefault(text:) Extension method

    Sets the text that is shown if there are not applications that can handle the content type.

    Declaration

    Swift

    @inlinable
func setDefault(text: UnsafePointer<gchar>!)
    Show on GitHub
  • setShowAll(setting:) Extension method

    Sets whether the app chooser should show all applications in a flat list.

    Declaration

    Swift

    @inlinable
func setShowAll(setting: Bool)
    Show on GitHub
  • setShowDefault(setting:) Extension method

    Sets whether the app chooser should show the default handler for the content type in a separate section.

    Declaration

    Swift

    @inlinable
func setShowDefault(setting: Bool)
    Show on GitHub
  • setShowFallback(setting:) Extension method

    Sets whether the app chooser should show related applications for the content type in a separate section.

    Declaration

    Swift

    @inlinable
func setShowFallback(setting: Bool)
    Show on GitHub
  • setShowOther(setting:) Extension method

    Sets whether the app chooser should show applications which are unrelated to the content type.

    Declaration

    Swift

    @inlinable
func setShowOther(setting: Bool)
    Show on GitHub
  • setShowRecommended(setting:) Extension method

    Sets whether the app chooser should show recommended applications for the content type in a separate section.

    Declaration

    Swift

    @inlinable
func setShowRecommended(setting: Bool)
    Show on GitHub
  • defaultText Extension method

    Returns the text that is shown if there are not applications that can handle the content type.

    Declaration

    Swift

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

    Returns the current value of the GtkAppChooserWidget:show-all property.

    Declaration

    Swift

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

    Returns the current value of the GtkAppChooserWidget:show-default property.

    Declaration

    Swift

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

    Returns the current value of the GtkAppChooserWidget:show-fallback property.

    Declaration

    Swift

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

    Returns the current value of the GtkAppChooserWidget:show-other property.

    Declaration

    Swift

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

    Returns the current value of the GtkAppChooserWidget:show-recommended property.

    Declaration

    Swift

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

    Undocumented

    Declaration

    Swift

    @inlinable
var parent: GtkBox { get }
    Show on GitHub