Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- newtype AppChooserButton = AppChooserButton (ManagedPtr AppChooserButton)
- class GObject o => IsAppChooserButton o
- toAppChooserButton :: IsAppChooserButton o => o -> IO AppChooserButton
- noAppChooserButton :: Maybe AppChooserButton
- data AppChooserButtonAppendCustomItemMethodInfo
- appChooserButtonAppendCustomItem :: (HasCallStack, MonadIO m, IsAppChooserButton a, IsIcon b) => a -> Text -> Text -> b -> m ()
- data AppChooserButtonAppendSeparatorMethodInfo
- appChooserButtonAppendSeparator :: (HasCallStack, MonadIO m, IsAppChooserButton a) => a -> m ()
- data AppChooserButtonGetHeadingMethodInfo
- appChooserButtonGetHeading :: (HasCallStack, MonadIO m, IsAppChooserButton a) => a -> m (Maybe Text)
- data AppChooserButtonGetShowDefaultItemMethodInfo
- appChooserButtonGetShowDefaultItem :: (HasCallStack, MonadIO m, IsAppChooserButton a) => a -> m Bool
- data AppChooserButtonGetShowDialogItemMethodInfo
- appChooserButtonGetShowDialogItem :: (HasCallStack, MonadIO m, IsAppChooserButton a) => a -> m Bool
- appChooserButtonNew :: (HasCallStack, MonadIO m) => Text -> m AppChooserButton
- data AppChooserButtonSetActiveCustomItemMethodInfo
- appChooserButtonSetActiveCustomItem :: (HasCallStack, MonadIO m, IsAppChooserButton a) => a -> Text -> m ()
- data AppChooserButtonSetHeadingMethodInfo
- appChooserButtonSetHeading :: (HasCallStack, MonadIO m, IsAppChooserButton a) => a -> Text -> m ()
- data AppChooserButtonSetShowDefaultItemMethodInfo
- appChooserButtonSetShowDefaultItem :: (HasCallStack, MonadIO m, IsAppChooserButton a) => a -> Bool -> m ()
- data AppChooserButtonSetShowDialogItemMethodInfo
- appChooserButtonSetShowDialogItem :: (HasCallStack, MonadIO m, IsAppChooserButton a) => a -> Bool -> m ()
- data AppChooserButtonHeadingPropertyInfo
- appChooserButtonHeading :: AttrLabelProxy "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 ()
- data AppChooserButtonShowDefaultItemPropertyInfo
- appChooserButtonShowDefaultItem :: AttrLabelProxy "showDefaultItem"
- constructAppChooserButtonShowDefaultItem :: IsAppChooserButton o => Bool -> IO (GValueConstruct o)
- getAppChooserButtonShowDefaultItem :: (MonadIO m, IsAppChooserButton o) => o -> m Bool
- setAppChooserButtonShowDefaultItem :: (MonadIO m, IsAppChooserButton o) => o -> Bool -> m ()
- data AppChooserButtonShowDialogItemPropertyInfo
- appChooserButtonShowDialogItem :: AttrLabelProxy "showDialogItem"
- constructAppChooserButtonShowDialogItem :: IsAppChooserButton o => Bool -> IO (GValueConstruct o)
- getAppChooserButtonShowDialogItem :: (MonadIO m, IsAppChooserButton o) => o -> m Bool
- setAppChooserButtonShowDialogItem :: (MonadIO m, IsAppChooserButton o) => o -> Bool -> m ()
- type AppChooserButtonCustomItemActivatedCallback = Text -> IO ()
- data AppChooserButtonCustomItemActivatedSignalInfo
- type C_AppChooserButtonCustomItemActivatedCallback = Ptr () -> CString -> Ptr () -> IO ()
- afterAppChooserButtonCustomItemActivated :: (GObject a, MonadIO m) => a -> AppChooserButtonCustomItemActivatedCallback -> m SignalHandlerId
- genClosure_AppChooserButtonCustomItemActivated :: AppChooserButtonCustomItemActivatedCallback -> IO Closure
- mk_AppChooserButtonCustomItemActivatedCallback :: C_AppChooserButtonCustomItemActivatedCallback -> IO (FunPtr C_AppChooserButtonCustomItemActivatedCallback)
- noAppChooserButtonCustomItemActivatedCallback :: Maybe AppChooserButtonCustomItemActivatedCallback
- onAppChooserButtonCustomItemActivated :: (GObject a, MonadIO m) => a -> AppChooserButtonCustomItemActivatedCallback -> m SignalHandlerId
- wrap_AppChooserButtonCustomItemActivatedCallback :: AppChooserButtonCustomItemActivatedCallback -> Ptr () -> CString -> Ptr () -> IO ()
Exported types
newtype AppChooserButton Source #
GObject AppChooserButton Source # | |
IsImplementorIface AppChooserButton Source # | |
IsObject AppChooserButton Source # | |
IsWidget AppChooserButton Source # | |
IsContainer AppChooserButton Source # | |
IsComboBox AppChooserButton Source # | |
IsBin AppChooserButton Source # | |
IsCellLayout AppChooserButton Source # | |
IsCellEditable AppChooserButton Source # | |
IsBuildable AppChooserButton Source # | |
IsAppChooser AppChooserButton Source # | |
IsAppChooserButton AppChooserButton Source # | |
((~) * info (ResolveAppChooserButtonMethod t AppChooserButton), MethodInfo * info AppChooserButton p) => IsLabel t (AppChooserButton -> p) Source # | |
((~) * info (ResolveAppChooserButtonMethod t AppChooserButton), MethodInfo * info AppChooserButton p) => IsLabelProxy t (AppChooserButton -> p) Source # | |
HasAttributeList * AppChooserButton Source # | |
type AttributeList AppChooserButton Source # | |
type SignalList AppChooserButton Source # | |
class GObject o => IsAppChooserButton o Source #
toAppChooserButton :: IsAppChooserButton o => o -> IO AppChooserButton Source #
Methods
appendCustomItem
data AppChooserButtonAppendCustomItemMethodInfo Source #
((~) * signature (Text -> Text -> b -> m ()), MonadIO m, IsAppChooserButton a, IsIcon b) => MethodInfo * AppChooserButtonAppendCustomItemMethodInfo a signature Source # | |
appChooserButtonAppendCustomItem Source #
:: (HasCallStack, MonadIO m, IsAppChooserButton a, IsIcon b) | |
=> a |
|
-> Text |
|
-> Text |
|
-> b |
|
-> 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
data AppChooserButtonAppendSeparatorMethodInfo Source #
((~) * signature (m ()), MonadIO m, IsAppChooserButton a) => MethodInfo * AppChooserButtonAppendSeparatorMethodInfo a signature Source # | |
appChooserButtonAppendSeparator Source #
:: (HasCallStack, MonadIO m, IsAppChooserButton a) | |
=> a |
|
-> m () |
Appends a separator to the list of applications that is shown in the popup.
Since: 3.0
getHeading
data AppChooserButtonGetHeadingMethodInfo Source #
((~) * signature (m (Maybe Text)), MonadIO m, IsAppChooserButton a) => MethodInfo * AppChooserButtonGetHeadingMethodInfo a signature Source # | |
appChooserButtonGetHeading Source #
:: (HasCallStack, MonadIO m, IsAppChooserButton a) | |
=> a |
|
-> m (Maybe Text) | Returns: the text to display at the top of the dialog,
or |
Returns the text to display at the top of the dialog.
getShowDefaultItem
data AppChooserButtonGetShowDefaultItemMethodInfo Source #
((~) * signature (m Bool), MonadIO m, IsAppChooserButton a) => MethodInfo * AppChooserButtonGetShowDefaultItemMethodInfo a signature Source # | |
appChooserButtonGetShowDefaultItem Source #
:: (HasCallStack, MonadIO m, IsAppChooserButton a) | |
=> a |
|
-> m Bool | Returns: the value of |
Returns the current value of the AppChooserButton
:show-default-item
property.
Since: 3.2
getShowDialogItem
data AppChooserButtonGetShowDialogItemMethodInfo Source #
((~) * signature (m Bool), MonadIO m, IsAppChooserButton a) => MethodInfo * AppChooserButtonGetShowDialogItemMethodInfo a signature Source # | |
appChooserButtonGetShowDialogItem Source #
:: (HasCallStack, MonadIO m, IsAppChooserButton a) | |
=> a |
|
-> m Bool | Returns: the value of |
Returns the current value of the AppChooserButton
:show-dialog-item
property.
Since: 3.0
new
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m AppChooserButton | Returns: a newly created |
Creates a new AppChooserButton
for applications
that can handle content of the given type.
Since: 3.0
setActiveCustomItem
data AppChooserButtonSetActiveCustomItemMethodInfo Source #
((~) * signature (Text -> m ()), MonadIO m, IsAppChooserButton a) => MethodInfo * AppChooserButtonSetActiveCustomItemMethodInfo a signature Source # | |
appChooserButtonSetActiveCustomItem Source #
:: (HasCallStack, MonadIO m, IsAppChooserButton a) | |
=> a |
|
-> Text |
|
-> m () |
Selects a custom item previously added with
appChooserButtonAppendCustomItem
.
Use appChooserRefresh
to bring the selection
to its initial state.
Since: 3.0
setHeading
data AppChooserButtonSetHeadingMethodInfo Source #
((~) * signature (Text -> m ()), MonadIO m, IsAppChooserButton a) => MethodInfo * AppChooserButtonSetHeadingMethodInfo a signature Source # | |
appChooserButtonSetHeading Source #
:: (HasCallStack, MonadIO m, IsAppChooserButton a) | |
=> a |
|
-> Text |
|
-> 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
data AppChooserButtonSetShowDefaultItemMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m, IsAppChooserButton a) => MethodInfo * AppChooserButtonSetShowDefaultItemMethodInfo a signature Source # | |
appChooserButtonSetShowDefaultItem Source #
:: (HasCallStack, MonadIO m, IsAppChooserButton a) | |
=> a |
|
-> Bool |
|
-> 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
data AppChooserButtonSetShowDialogItemMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m, IsAppChooserButton a) => MethodInfo * AppChooserButtonSetShowDialogItemMethodInfo a signature Source # | |
appChooserButtonSetShowDialogItem Source #
:: (HasCallStack, MonadIO m, IsAppChooserButton a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the dropdown menu of this button should show an
entry to trigger a AppChooserDialog
.
Since: 3.0
Properties
heading
data AppChooserButtonHeadingPropertyInfo Source #
appChooserButtonHeading :: AttrLabelProxy "heading" Source #
constructAppChooserButtonHeading :: IsAppChooserButton o => Text -> IO (GValueConstruct o) Source #
getAppChooserButtonHeading :: (MonadIO m, IsAppChooserButton o) => o -> m (Maybe Text) Source #
setAppChooserButtonHeading :: (MonadIO m, IsAppChooserButton o) => o -> Text -> m () Source #
showDefaultItem
data AppChooserButtonShowDefaultItemPropertyInfo Source #
appChooserButtonShowDefaultItem :: AttrLabelProxy "showDefaultItem" Source #
constructAppChooserButtonShowDefaultItem :: IsAppChooserButton o => Bool -> IO (GValueConstruct o) Source #
getAppChooserButtonShowDefaultItem :: (MonadIO m, IsAppChooserButton o) => o -> m Bool Source #
setAppChooserButtonShowDefaultItem :: (MonadIO m, IsAppChooserButton o) => o -> Bool -> m () Source #
showDialogItem
data AppChooserButtonShowDialogItemPropertyInfo Source #
appChooserButtonShowDialogItem :: AttrLabelProxy "showDialogItem" Source #
constructAppChooserButtonShowDialogItem :: IsAppChooserButton o => Bool -> IO (GValueConstruct o) Source #
getAppChooserButtonShowDialogItem :: (MonadIO m, IsAppChooserButton o) => o -> m Bool Source #
setAppChooserButtonShowDialogItem :: (MonadIO m, IsAppChooserButton o) => o -> Bool -> m () Source #
Signals
customItemActivated
type AppChooserButtonCustomItemActivatedCallback = Text -> IO () Source #
afterAppChooserButtonCustomItemActivated :: (GObject a, MonadIO m) => a -> AppChooserButtonCustomItemActivatedCallback -> m SignalHandlerId Source #
genClosure_AppChooserButtonCustomItemActivated :: AppChooserButtonCustomItemActivatedCallback -> IO Closure Source #
mk_AppChooserButtonCustomItemActivatedCallback :: C_AppChooserButtonCustomItemActivatedCallback -> IO (FunPtr C_AppChooserButtonCustomItemActivatedCallback) Source #
noAppChooserButtonCustomItemActivatedCallback :: Maybe AppChooserButtonCustomItemActivatedCallback Source #
onAppChooserButtonCustomItemActivated :: (GObject a, MonadIO m) => a -> AppChooserButtonCustomItemActivatedCallback -> m SignalHandlerId Source #
wrap_AppChooserButtonCustomItemActivatedCallback :: AppChooserButtonCustomItemActivatedCallback -> Ptr () -> CString -> Ptr () -> IO () Source #