GI.Gtk.Objects.AppChooserWidget

AppChooserWidget is a widget for selecting applications. It is the main building block for AppChooserDialog. 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.

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

To keep track of the selected application, use the applicationSelected and applicationActivated signals.

CSS nodes

GtkAppChooserWidget has a single CSS node with name appchooser.

Exported types

newtype AppChooserWidget

Memory-managed wrapper type.

Constructors

AppChooserWidget (ManagedPtr AppChooserWidget)

Instances

Eq AppChooserWidget

Defined in GI.Gtk.Objects.AppChooserWidget

Methods

(==) :: AppChooserWidget -> AppChooserWidget -> Bool

(/=) :: AppChooserWidget -> AppChooserWidget -> Bool

IsGValue AppChooserWidget

Convert AppChooserWidget to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.AppChooserWidget

Methods

toGValue :: AppChooserWidget -> IO GValue

fromGValue :: GValue -> IO AppChooserWidget

GObject AppChooserWidget

Defined in GI.Gtk.Objects.AppChooserWidget

Methods

gobjectType :: IO GType

HasParentTypes AppChooserWidget

Defined in GI.Gtk.Objects.AppChooserWidget

type ParentTypes AppChooserWidget

Defined in GI.Gtk.Objects.AppChooserWidget

type ParentTypes AppChooserWidget = '[Box, Container, Widget, Object, ImplementorIface, AppChooser, Buildable, Orientable]

class (GObject o, IsDescendantOf AppChooserWidget o) => IsAppChooserWidget o

Type class for types which can be safely cast to AppChooserWidget, for instance with toAppChooserWidget.

Instances

(GObject o, IsDescendantOf AppChooserWidget o) => IsAppChooserWidget o

Defined in GI.Gtk.Objects.AppChooserWidget

toAppChooserWidget :: (MonadIO m, IsAppChooserWidget o) => o -> m AppChooserWidget

Cast to AppChooserWidget, for types for which this is known to be safe. For general casts, use castTo.

noAppChooserWidget :: Maybe AppChooserWidget

A convenience alias for Nothing :: Maybe AppChooserWidget.

Methods

Overloaded methods

getDefaultText

appChooserWidgetGetDefaultText

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a)

=> a

self: a AppChooserWidget

-> m Text

Returns: the value of AppChooserWidget:default-text

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

Since: 3.0

getShowAll

appChooserWidgetGetShowAll

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a)

=> a

self: a AppChooserWidget

-> m Bool

Returns: the value of AppChooserWidget:show-all

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

Since: 3.0

getShowDefault

appChooserWidgetGetShowDefault

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a)

=> a

self: a AppChooserWidget

-> m Bool

Returns: the value of AppChooserWidget:show-default

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

Since: 3.0

getShowFallback

appChooserWidgetGetShowFallback

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a)

=> a

self: a AppChooserWidget

-> m Bool

Returns: the value of AppChooserWidget:show-fallback

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

Since: 3.0

getShowOther

appChooserWidgetGetShowOther

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a)

=> a

self: a AppChooserWidget

-> m Bool

Returns: the value of AppChooserWidget:show-other

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

Since: 3.0

getShowRecommended

appChooserWidgetGetShowRecommended

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a)

=> a

self: a AppChooserWidget

-> m Bool

Returns: the value of AppChooserWidget:show-recommended

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

Since: 3.0

new

appChooserWidgetNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

contentType: the content type to show applications for

-> m AppChooserWidget

Returns: a newly created AppChooserWidget

Creates a new AppChooserWidget for applications that can handle content of the given type.

Since: 3.0

setDefaultText

appChooserWidgetSetDefaultText

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a)

=> a

self: a AppChooserWidget

-> Text

text: the new value for AppChooserWidget:default-text

-> m ()

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

setShowAll

appChooserWidgetSetShowAll

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a)

=> a

self: a AppChooserWidget

-> Bool

setting: the new value for AppChooserWidget:show-all

-> m ()

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

Since: 3.0

setShowDefault

appChooserWidgetSetShowDefault

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a)

=> a

self: a AppChooserWidget

-> Bool

setting: the new value for AppChooserWidget:show-default

-> m ()

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

Since: 3.0

setShowFallback

appChooserWidgetSetShowFallback

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a)

=> a

self: a AppChooserWidget

-> Bool

setting: the new value for AppChooserWidget:show-fallback

-> m ()

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

Since: 3.0

setShowOther

appChooserWidgetSetShowOther

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a)

=> a

self: a AppChooserWidget

-> Bool

setting: the new value for AppChooserWidget:show-other

-> m ()

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

Since: 3.0

setShowRecommended

appChooserWidgetSetShowRecommended

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a)

=> a

self: a AppChooserWidget

-> Bool

setting: the new value for AppChooserWidget:show-recommended

-> m ()

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

Since: 3.0

Properties

defaultText

The AppChooserWidget:default-text property determines the text that appears in the widget when there are no applications for the given content type. See also appChooserWidgetSetDefaultText.

constructAppChooserWidgetDefaultText :: IsAppChooserWidget o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “default-text” property. This is rarely needed directly, but it is used by new.

getAppChooserWidgetDefaultText :: (MonadIO m, IsAppChooserWidget o) => o -> m Text

Get the value of the “default-text” property. When overloading is enabled, this is equivalent to

get appChooserWidget #defaultText

setAppChooserWidgetDefaultText :: (MonadIO m, IsAppChooserWidget o) => o -> Text -> m ()

Set the value of the “default-text” property. When overloading is enabled, this is equivalent to

set appChooserWidget [ #defaultText := value ]

showAll

If the AppChooserWidget:show-all property is True, the app chooser presents all applications in a single list, without subsections for default, recommended or related applications.

constructAppChooserWidgetShowAll :: IsAppChooserWidget o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “show-all” property. This is rarely needed directly, but it is used by new.

getAppChooserWidgetShowAll :: (MonadIO m, IsAppChooserWidget o) => o -> m Bool

Get the value of the “show-all” property. When overloading is enabled, this is equivalent to

get appChooserWidget #showAll

setAppChooserWidgetShowAll :: (MonadIO m, IsAppChooserWidget o) => o -> Bool -> m ()

Set the value of the “show-all” property. When overloading is enabled, this is equivalent to

set appChooserWidget [ #showAll := value ]

showDefault

The showDefault property determines whether the app chooser should show the default handler for the content type in a separate section. If False, the default handler is listed among the recommended applications.

constructAppChooserWidgetShowDefault :: IsAppChooserWidget o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “show-default” property. This is rarely needed directly, but it is used by new.

getAppChooserWidgetShowDefault :: (MonadIO m, IsAppChooserWidget o) => o -> m Bool

Get the value of the “show-default” property. When overloading is enabled, this is equivalent to

get appChooserWidget #showDefault

setAppChooserWidgetShowDefault :: (MonadIO m, IsAppChooserWidget o) => o -> Bool -> m ()

Set the value of the “show-default” property. When overloading is enabled, this is equivalent to

set appChooserWidget [ #showDefault := value ]

showFallback

The AppChooserWidget:show-fallback property determines whether the app chooser should show a section for fallback applications. If False, the fallback applications are listed among the other applications.

constructAppChooserWidgetShowFallback :: IsAppChooserWidget o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “show-fallback” property. This is rarely needed directly, but it is used by new.

getAppChooserWidgetShowFallback :: (MonadIO m, IsAppChooserWidget o) => o -> m Bool

Get the value of the “show-fallback” property. When overloading is enabled, this is equivalent to

get appChooserWidget #showFallback

setAppChooserWidgetShowFallback :: (MonadIO m, IsAppChooserWidget o) => o -> Bool -> m ()

Set the value of the “show-fallback” property. When overloading is enabled, this is equivalent to

set appChooserWidget [ #showFallback := value ]

showOther

The AppChooserWidget:show-other property determines whether the app chooser should show a section for other applications.

constructAppChooserWidgetShowOther :: IsAppChooserWidget o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “show-other” property. This is rarely needed directly, but it is used by new.

getAppChooserWidgetShowOther :: (MonadIO m, IsAppChooserWidget o) => o -> m Bool

Get the value of the “show-other” property. When overloading is enabled, this is equivalent to

get appChooserWidget #showOther

setAppChooserWidgetShowOther :: (MonadIO m, IsAppChooserWidget o) => o -> Bool -> m ()

Set the value of the “show-other” property. When overloading is enabled, this is equivalent to

set appChooserWidget [ #showOther := value ]

showRecommended

The AppChooserWidget:show-recommended property determines whether the app chooser should show a section for recommended applications. If False, the recommended applications are listed among the other applications.

constructAppChooserWidgetShowRecommended :: IsAppChooserWidget o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “show-recommended” property. This is rarely needed directly, but it is used by new.

getAppChooserWidgetShowRecommended :: (MonadIO m, IsAppChooserWidget o) => o -> m Bool

Get the value of the “show-recommended” property. When overloading is enabled, this is equivalent to

get appChooserWidget #showRecommended

setAppChooserWidgetShowRecommended :: (MonadIO m, IsAppChooserWidget o) => o -> Bool -> m ()

Set the value of the “show-recommended” property. When overloading is enabled, this is equivalent to

set appChooserWidget [ #showRecommended := value ]

Signals

applicationActivated

type AppChooserWidgetApplicationActivatedCallback

Arguments

 = AppInfo

application: the activated AppInfo

-> IO ()

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.

type C_AppChooserWidgetApplicationActivatedCallback = Ptr () -> Ptr AppInfo -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

afterAppChooserWidgetApplicationActivated :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetApplicationActivatedCallback -> m SignalHandlerId

Connect a signal handler for the applicationActivated signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after appChooserWidget #applicationActivated callback

genClosure_AppChooserWidgetApplicationActivated :: MonadIO m => AppChooserWidgetApplicationActivatedCallback -> m (GClosure C_AppChooserWidgetApplicationActivatedCallback)

Wrap the callback into a GClosure.

mk_AppChooserWidgetApplicationActivatedCallback :: C_AppChooserWidgetApplicationActivatedCallback -> IO (FunPtr C_AppChooserWidgetApplicationActivatedCallback)

Generate a function pointer callable from C code, from a C_AppChooserWidgetApplicationActivatedCallback.

noAppChooserWidgetApplicationActivatedCallback :: Maybe AppChooserWidgetApplicationActivatedCallback

A convenience synonym for Nothing :: Maybe AppChooserWidgetApplicationActivatedCallback.

onAppChooserWidgetApplicationActivated :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetApplicationActivatedCallback -> m SignalHandlerId

Connect a signal handler for the applicationActivated signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on appChooserWidget #applicationActivated callback

wrap_AppChooserWidgetApplicationActivatedCallback :: AppChooserWidgetApplicationActivatedCallback -> C_AppChooserWidgetApplicationActivatedCallback

Wrap a AppChooserWidgetApplicationActivatedCallback into a C_AppChooserWidgetApplicationActivatedCallback.

applicationSelected

type AppChooserWidgetApplicationSelectedCallback

Arguments

 = AppInfo

application: the selected AppInfo

-> IO ()

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

type C_AppChooserWidgetApplicationSelectedCallback = Ptr () -> Ptr AppInfo -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

afterAppChooserWidgetApplicationSelected :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetApplicationSelectedCallback -> m SignalHandlerId

Connect a signal handler for the applicationSelected signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after appChooserWidget #applicationSelected callback

genClosure_AppChooserWidgetApplicationSelected :: MonadIO m => AppChooserWidgetApplicationSelectedCallback -> m (GClosure C_AppChooserWidgetApplicationSelectedCallback)

Wrap the callback into a GClosure.

mk_AppChooserWidgetApplicationSelectedCallback :: C_AppChooserWidgetApplicationSelectedCallback -> IO (FunPtr C_AppChooserWidgetApplicationSelectedCallback)

Generate a function pointer callable from C code, from a C_AppChooserWidgetApplicationSelectedCallback.

noAppChooserWidgetApplicationSelectedCallback :: Maybe AppChooserWidgetApplicationSelectedCallback

A convenience synonym for Nothing :: Maybe AppChooserWidgetApplicationSelectedCallback.

onAppChooserWidgetApplicationSelected :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetApplicationSelectedCallback -> m SignalHandlerId

Connect a signal handler for the applicationSelected signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on appChooserWidget #applicationSelected callback

wrap_AppChooserWidgetApplicationSelectedCallback :: AppChooserWidgetApplicationSelectedCallback -> C_AppChooserWidgetApplicationSelectedCallback

Wrap a AppChooserWidgetApplicationSelectedCallback into a C_AppChooserWidgetApplicationSelectedCallback.

populatePopup

type AppChooserWidgetPopulatePopupCallback

Arguments

 = Menu

menu: the Menu to populate

-> AppInfo

application: the current AppInfo

-> IO ()

Emitted when a context menu is about to popup over an application item. Clients can insert menu items into the provided Menu 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.

type C_AppChooserWidgetPopulatePopupCallback = Ptr () -> Ptr Menu -> Ptr AppInfo -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

afterAppChooserWidgetPopulatePopup :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetPopulatePopupCallback -> m SignalHandlerId

Connect a signal handler for the populatePopup signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after appChooserWidget #populatePopup callback

genClosure_AppChooserWidgetPopulatePopup :: MonadIO m => AppChooserWidgetPopulatePopupCallback -> m (GClosure C_AppChooserWidgetPopulatePopupCallback)

Wrap the callback into a GClosure.

mk_AppChooserWidgetPopulatePopupCallback :: C_AppChooserWidgetPopulatePopupCallback -> IO (FunPtr C_AppChooserWidgetPopulatePopupCallback)

Generate a function pointer callable from C code, from a C_AppChooserWidgetPopulatePopupCallback.

noAppChooserWidgetPopulatePopupCallback :: Maybe AppChooserWidgetPopulatePopupCallback

A convenience synonym for Nothing :: Maybe AppChooserWidgetPopulatePopupCallback.

onAppChooserWidgetPopulatePopup :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetPopulatePopupCallback -> m SignalHandlerId

Connect a signal handler for the populatePopup signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on appChooserWidget #populatePopup callback

wrap_AppChooserWidgetPopulatePopupCallback :: AppChooserWidgetPopulatePopupCallback -> C_AppChooserWidgetPopulatePopupCallback

Wrap a AppChooserWidgetPopulatePopupCallback into a C_AppChooserWidgetPopulatePopupCallback.