GI.Gtk.Objects.AppChooserButton

The AppChooserButton is a widget that lets the user select an application. It implements the AppChooser interface.

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

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

It is possible to add custom items to the list, using appChooserButtonAppendCustomItem. These items cause the customItemActivated signal to be emitted when they are selected.

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

Exported types

newtype AppChooserButton

Memory-managed wrapper type.

Constructors

AppChooserButton (ManagedPtr AppChooserButton)

Instances

Eq AppChooserButton

Defined in GI.Gtk.Objects.AppChooserButton

Methods

(==) :: AppChooserButton -> AppChooserButton -> Bool

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

IsGValue AppChooserButton

Convert AppChooserButton to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.AppChooserButton

Methods

toGValue :: AppChooserButton -> IO GValue

fromGValue :: GValue -> IO AppChooserButton

GObject AppChooserButton

Defined in GI.Gtk.Objects.AppChooserButton

Methods

gobjectType :: IO GType

HasParentTypes AppChooserButton

Defined in GI.Gtk.Objects.AppChooserButton

type ParentTypes AppChooserButton

Defined in GI.Gtk.Objects.AppChooserButton

type ParentTypes AppChooserButton = '[ComboBox, Bin, Container, Widget, Object, ImplementorIface, AppChooser, Buildable, CellEditable, CellLayout]

class (GObject o, IsDescendantOf AppChooserButton o) => IsAppChooserButton o

Type class for types which can be safely cast to AppChooserButton, for instance with toAppChooserButton.

Instances

(GObject o, IsDescendantOf AppChooserButton o) => IsAppChooserButton o

Defined in GI.Gtk.Objects.AppChooserButton

toAppChooserButton :: (MonadIO m, IsAppChooserButton o) => o -> m AppChooserButton

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

noAppChooserButton :: Maybe AppChooserButton

A convenience alias for Nothing :: Maybe AppChooserButton.

Methods

Overloaded methods

appendCustomItem

appChooserButtonAppendCustomItem

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a, IsIcon b)

=> a

self: a AppChooserButton

-> Text

name: the name of the custom item

-> Text

label: the label for the custom item

-> b

icon: the icon for the custom item

-> m ()

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 customItemActivated signal, to add a callback for the activation of a particular custom item in the list. See also appChooserButtonAppendSeparator.

Since: 3.0

appendSeparator

appChooserButtonAppendSeparator

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a AppChooserButton

-> m ()

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

Since: 3.0

getHeading

appChooserButtonGetHeading

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a AppChooserButton

-> m (Maybe Text)

Returns: the text to display at the top of the dialog, or Nothing, in which case a default text is displayed

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

getShowDefaultItem

appChooserButtonGetShowDefaultItem

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a AppChooserButton

-> m Bool

Returns: the value of AppChooserButton:show-default-item

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

Since: 3.2

getShowDialogItem

appChooserButtonGetShowDialogItem

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a AppChooserButton

-> m Bool

Returns: the value of AppChooserButton:show-dialog-item

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

Since: 3.0

new

appChooserButtonNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

contentType: the content type to show applications for

-> m AppChooserButton

Returns: a newly created AppChooserButton

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

Since: 3.0

setActiveCustomItem

appChooserButtonSetActiveCustomItem

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a AppChooserButton

-> Text

name: the name of the custom item

-> m ()

Selects a custom item previously added with appChooserButtonAppendCustomItem.

Use appChooserRefresh to bring the selection to its initial state.

Since: 3.0

setHeading

appChooserButtonSetHeading

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a AppChooserButton

-> Text

heading: a string containing Pango markup

-> m ()

Sets the text to display at the top of the dialog. If the heading is not set, the dialog displays a default text.

setShowDefaultItem

appChooserButtonSetShowDefaultItem

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a AppChooserButton

-> Bool

setting: the new value for AppChooserButton:show-default-item

-> m ()

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

Since: 3.2

setShowDialogItem

appChooserButtonSetShowDialogItem

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a AppChooserButton

-> Bool

setting: the new value for AppChooserButton:show-dialog-item

-> m ()

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

Since: 3.0

Properties

heading

The text to show at the top of the dialog that can be opened from the button. The string may contain Pango markup.

constructAppChooserButtonHeading :: IsAppChooserButton o => Text -> IO (GValueConstruct o)

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

getAppChooserButtonHeading :: (MonadIO m, IsAppChooserButton o) => o -> m (Maybe Text)

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

get appChooserButton #heading

setAppChooserButtonHeading :: (MonadIO m, IsAppChooserButton o) => o -> Text -> m ()

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

set appChooserButton [ #heading := value ]

showDefaultItem

The AppChooserButton:show-default-item property determines whether the dropdown menu should show the default application on top for the provided content type.

Since: 3.2

constructAppChooserButtonShowDefaultItem :: IsAppChooserButton o => Bool -> IO (GValueConstruct o)

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

getAppChooserButtonShowDefaultItem :: (MonadIO m, IsAppChooserButton o) => o -> m Bool

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

get appChooserButton #showDefaultItem

setAppChooserButtonShowDefaultItem :: (MonadIO m, IsAppChooserButton o) => o -> Bool -> m ()

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

set appChooserButton [ #showDefaultItem := value ]

showDialogItem

The AppChooserButton:show-dialog-item property determines whether the dropdown menu should show an item that triggers a AppChooserDialog when clicked.

constructAppChooserButtonShowDialogItem :: IsAppChooserButton o => Bool -> IO (GValueConstruct o)

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

getAppChooserButtonShowDialogItem :: (MonadIO m, IsAppChooserButton o) => o -> m Bool

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

get appChooserButton #showDialogItem

setAppChooserButtonShowDialogItem :: (MonadIO m, IsAppChooserButton o) => o -> Bool -> m ()

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

set appChooserButton [ #showDialogItem := value ]

Signals

customItemActivated

type AppChooserButtonCustomItemActivatedCallback

Arguments

 = Text

itemName: the name of the activated item

-> IO ()

Emitted when a custom item, previously added with appChooserButtonAppendCustomItem, is activated from the dropdown menu.

type C_AppChooserButtonCustomItemActivatedCallback = Ptr () -> CString -> Ptr () -> IO ()

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

afterAppChooserButtonCustomItemActivated :: (IsAppChooserButton a, MonadIO m) => a -> Maybe Text -> AppChooserButtonCustomItemActivatedCallback -> m SignalHandlerId

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

after appChooserButton #customItemActivated callback

This signal admits a optional parameter detail. If it's not Nothing, we will connect to “custom-item-activated::detail” instead.

genClosure_AppChooserButtonCustomItemActivated :: MonadIO m => AppChooserButtonCustomItemActivatedCallback -> m (GClosure C_AppChooserButtonCustomItemActivatedCallback)

Wrap the callback into a GClosure.

mk_AppChooserButtonCustomItemActivatedCallback :: C_AppChooserButtonCustomItemActivatedCallback -> IO (FunPtr C_AppChooserButtonCustomItemActivatedCallback)

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

noAppChooserButtonCustomItemActivatedCallback :: Maybe AppChooserButtonCustomItemActivatedCallback

A convenience synonym for Nothing :: Maybe AppChooserButtonCustomItemActivatedCallback.

onAppChooserButtonCustomItemActivated :: (IsAppChooserButton a, MonadIO m) => a -> Maybe Text -> AppChooserButtonCustomItemActivatedCallback -> m SignalHandlerId

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

on appChooserButton #customItemActivated callback

This signal admits a optional parameter detail. If it's not Nothing, we will connect to “custom-item-activated::detail” instead.

wrap_AppChooserButtonCustomItemActivatedCallback :: AppChooserButtonCustomItemActivatedCallback -> C_AppChooserButtonCustomItemActivatedCallback

Wrap a AppChooserButtonCustomItemActivatedCallback into a C_AppChooserButtonCustomItemActivatedCallback.