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 AppChooserButton::custom-item-activated signal to be emitted when they are selected.

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

Exported types

newtype AppChooserButton

Constructors

AppChooserButton (ManagedPtr AppChooserButton)

Instances

GObject AppChooserButton

Methods

gobjectType :: AppChooserButton -> IO GType

IsImplementorIface AppChooserButton

IsObject AppChooserButton

IsWidget AppChooserButton

IsContainer AppChooserButton

IsComboBox AppChooserButton

IsBin AppChooserButton

IsCellLayout AppChooserButton

IsCellEditable AppChooserButton

IsBuildable AppChooserButton

IsAppChooser AppChooserButton

IsAppChooserButton AppChooserButton

class GObject o => IsAppChooserButton o

Instances

(GObject a, UnknownAncestorError Constraint AppChooserButton a) => IsAppChooserButton a

IsAppChooserButton AppChooserButton

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

noAppChooserButton :: Maybe AppChooserButton

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 AppChooserButton::custom-item-activated 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

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

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

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

showDefaultItem

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

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

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

showDialogItem

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

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

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

Signals

customItemActivated

type AppChooserButtonCustomItemActivatedCallback = Text -> IO ()

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

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

genClosure_AppChooserButtonCustomItemActivated :: AppChooserButtonCustomItemActivatedCallback -> IO Closure

mk_AppChooserButtonCustomItemActivatedCallback :: C_AppChooserButtonCustomItemActivatedCallback -> IO (FunPtr C_AppChooserButtonCustomItemActivatedCallback)

noAppChooserButtonCustomItemActivatedCallback :: Maybe AppChooserButtonCustomItemActivatedCallback

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

wrap_AppChooserButtonCustomItemActivatedCallback :: AppChooserButtonCustomItemActivatedCallback -> Ptr () -> CString -> Ptr () -> IO ()