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 |
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
AppChooserWidget
::application-selected
and AppChooserWidget
::application-activated
signals.
CSS nodes
GtkAppChooserWidget has a single CSS node with name appchooser.
Synopsis
- newtype AppChooserWidget = AppChooserWidget (ManagedPtr AppChooserWidget)
- class GObject o => IsAppChooserWidget o
- toAppChooserWidget :: (MonadIO m, IsAppChooserWidget o) => o -> m AppChooserWidget
- noAppChooserWidget :: Maybe AppChooserWidget
- appChooserWidgetGetDefaultText :: (HasCallStack, MonadIO m, IsAppChooserWidget a) => a -> m Text
- appChooserWidgetGetShowAll :: (HasCallStack, MonadIO m, IsAppChooserWidget a) => a -> m Bool
- appChooserWidgetGetShowDefault :: (HasCallStack, MonadIO m, IsAppChooserWidget a) => a -> m Bool
- appChooserWidgetGetShowFallback :: (HasCallStack, MonadIO m, IsAppChooserWidget a) => a -> m Bool
- appChooserWidgetGetShowOther :: (HasCallStack, MonadIO m, IsAppChooserWidget a) => a -> m Bool
- appChooserWidgetGetShowRecommended :: (HasCallStack, MonadIO m, IsAppChooserWidget a) => a -> m Bool
- appChooserWidgetNew :: (HasCallStack, MonadIO m) => Text -> m AppChooserWidget
- appChooserWidgetSetDefaultText :: (HasCallStack, MonadIO m, IsAppChooserWidget a) => a -> Text -> m ()
- appChooserWidgetSetShowAll :: (HasCallStack, MonadIO m, IsAppChooserWidget a) => a -> Bool -> m ()
- appChooserWidgetSetShowDefault :: (HasCallStack, MonadIO m, IsAppChooserWidget a) => a -> Bool -> m ()
- appChooserWidgetSetShowFallback :: (HasCallStack, MonadIO m, IsAppChooserWidget a) => a -> Bool -> m ()
- appChooserWidgetSetShowOther :: (HasCallStack, MonadIO m, IsAppChooserWidget a) => a -> Bool -> m ()
- appChooserWidgetSetShowRecommended :: (HasCallStack, MonadIO m, IsAppChooserWidget a) => a -> Bool -> m ()
- constructAppChooserWidgetDefaultText :: IsAppChooserWidget o => Text -> IO (GValueConstruct o)
- getAppChooserWidgetDefaultText :: (MonadIO m, IsAppChooserWidget o) => o -> m Text
- setAppChooserWidgetDefaultText :: (MonadIO m, IsAppChooserWidget o) => o -> Text -> m ()
- constructAppChooserWidgetShowAll :: IsAppChooserWidget o => Bool -> IO (GValueConstruct o)
- getAppChooserWidgetShowAll :: (MonadIO m, IsAppChooserWidget o) => o -> m Bool
- setAppChooserWidgetShowAll :: (MonadIO m, IsAppChooserWidget o) => o -> Bool -> m ()
- constructAppChooserWidgetShowDefault :: IsAppChooserWidget o => Bool -> IO (GValueConstruct o)
- getAppChooserWidgetShowDefault :: (MonadIO m, IsAppChooserWidget o) => o -> m Bool
- setAppChooserWidgetShowDefault :: (MonadIO m, IsAppChooserWidget o) => o -> Bool -> m ()
- constructAppChooserWidgetShowFallback :: IsAppChooserWidget o => Bool -> IO (GValueConstruct o)
- getAppChooserWidgetShowFallback :: (MonadIO m, IsAppChooserWidget o) => o -> m Bool
- setAppChooserWidgetShowFallback :: (MonadIO m, IsAppChooserWidget o) => o -> Bool -> m ()
- constructAppChooserWidgetShowOther :: IsAppChooserWidget o => Bool -> IO (GValueConstruct o)
- getAppChooserWidgetShowOther :: (MonadIO m, IsAppChooserWidget o) => o -> m Bool
- setAppChooserWidgetShowOther :: (MonadIO m, IsAppChooserWidget o) => o -> Bool -> m ()
- constructAppChooserWidgetShowRecommended :: IsAppChooserWidget o => Bool -> IO (GValueConstruct o)
- getAppChooserWidgetShowRecommended :: (MonadIO m, IsAppChooserWidget o) => o -> m Bool
- setAppChooserWidgetShowRecommended :: (MonadIO m, IsAppChooserWidget o) => o -> Bool -> m ()
- type AppChooserWidgetApplicationActivatedCallback = AppInfo -> IO ()
- type C_AppChooserWidgetApplicationActivatedCallback = Ptr () -> Ptr AppInfo -> Ptr () -> IO ()
- afterAppChooserWidgetApplicationActivated :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetApplicationActivatedCallback -> m SignalHandlerId
- genClosure_AppChooserWidgetApplicationActivated :: AppChooserWidgetApplicationActivatedCallback -> IO Closure
- mk_AppChooserWidgetApplicationActivatedCallback :: C_AppChooserWidgetApplicationActivatedCallback -> IO (FunPtr C_AppChooserWidgetApplicationActivatedCallback)
- noAppChooserWidgetApplicationActivatedCallback :: Maybe AppChooserWidgetApplicationActivatedCallback
- onAppChooserWidgetApplicationActivated :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetApplicationActivatedCallback -> m SignalHandlerId
- wrap_AppChooserWidgetApplicationActivatedCallback :: AppChooserWidgetApplicationActivatedCallback -> C_AppChooserWidgetApplicationActivatedCallback
- type AppChooserWidgetApplicationSelectedCallback = AppInfo -> IO ()
- type C_AppChooserWidgetApplicationSelectedCallback = Ptr () -> Ptr AppInfo -> Ptr () -> IO ()
- afterAppChooserWidgetApplicationSelected :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetApplicationSelectedCallback -> m SignalHandlerId
- genClosure_AppChooserWidgetApplicationSelected :: AppChooserWidgetApplicationSelectedCallback -> IO Closure
- mk_AppChooserWidgetApplicationSelectedCallback :: C_AppChooserWidgetApplicationSelectedCallback -> IO (FunPtr C_AppChooserWidgetApplicationSelectedCallback)
- noAppChooserWidgetApplicationSelectedCallback :: Maybe AppChooserWidgetApplicationSelectedCallback
- onAppChooserWidgetApplicationSelected :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetApplicationSelectedCallback -> m SignalHandlerId
- wrap_AppChooserWidgetApplicationSelectedCallback :: AppChooserWidgetApplicationSelectedCallback -> C_AppChooserWidgetApplicationSelectedCallback
- type AppChooserWidgetPopulatePopupCallback = Menu -> AppInfo -> IO ()
- type C_AppChooserWidgetPopulatePopupCallback = Ptr () -> Ptr Menu -> Ptr AppInfo -> Ptr () -> IO ()
- afterAppChooserWidgetPopulatePopup :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetPopulatePopupCallback -> m SignalHandlerId
- genClosure_AppChooserWidgetPopulatePopup :: AppChooserWidgetPopulatePopupCallback -> IO Closure
- mk_AppChooserWidgetPopulatePopupCallback :: C_AppChooserWidgetPopulatePopupCallback -> IO (FunPtr C_AppChooserWidgetPopulatePopupCallback)
- noAppChooserWidgetPopulatePopupCallback :: Maybe AppChooserWidgetPopulatePopupCallback
- onAppChooserWidgetPopulatePopup :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetPopulatePopupCallback -> m SignalHandlerId
- wrap_AppChooserWidgetPopulatePopupCallback :: AppChooserWidgetPopulatePopupCallback -> C_AppChooserWidgetPopulatePopupCallback
Exported types
newtype AppChooserWidget Source #
Memory-managed wrapper type.
Instances
class GObject o => IsAppChooserWidget o Source #
Type class for types which can be safely cast to AppChooserWidget
, for instance with toAppChooserWidget
.
Instances
(GObject a, (UnknownAncestorError AppChooserWidget a :: Constraint)) => IsAppChooserWidget a Source # | |
Defined in GI.Gtk.Objects.AppChooserWidget | |
IsAppChooserWidget AppChooserWidget Source # | |
Defined in GI.Gtk.Objects.AppChooserWidget |
toAppChooserWidget :: (MonadIO m, IsAppChooserWidget o) => o -> m AppChooserWidget Source #
Cast to AppChooserWidget
, for types for which this is known to be safe. For general casts, use castTo
.
noAppChooserWidget :: Maybe AppChooserWidget Source #
A convenience alias for Nothing
:: Maybe
AppChooserWidget
.
Methods
getDefaultText
appChooserWidgetGetDefaultText Source #
:: (HasCallStack, MonadIO m, IsAppChooserWidget a) | |
=> a |
|
-> m Text | Returns: the value of |
Returns the text that is shown if there are not applications that can handle the content type.
Since: 3.0
getShowAll
appChooserWidgetGetShowAll Source #
:: (HasCallStack, MonadIO m, IsAppChooserWidget a) | |
=> a |
|
-> m Bool | Returns: the value of |
Returns the current value of the AppChooserWidget
:show-all
property.
Since: 3.0
getShowDefault
appChooserWidgetGetShowDefault Source #
:: (HasCallStack, MonadIO m, IsAppChooserWidget a) | |
=> a |
|
-> m Bool | Returns: the value of |
Returns the current value of the AppChooserWidget
:show-default
property.
Since: 3.0
getShowFallback
appChooserWidgetGetShowFallback Source #
:: (HasCallStack, MonadIO m, IsAppChooserWidget a) | |
=> a |
|
-> m Bool | Returns: the value of |
Returns the current value of the AppChooserWidget
:show-fallback
property.
Since: 3.0
getShowOther
appChooserWidgetGetShowOther Source #
:: (HasCallStack, MonadIO m, IsAppChooserWidget a) | |
=> a |
|
-> m Bool | Returns: the value of |
Returns the current value of the AppChooserWidget
:show-other
property.
Since: 3.0
getShowRecommended
appChooserWidgetGetShowRecommended Source #
:: (HasCallStack, MonadIO m, IsAppChooserWidget a) | |
=> a |
|
-> m Bool | Returns: the value of |
Returns the current value of the AppChooserWidget
:show-recommended
property.
Since: 3.0
new
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m AppChooserWidget | Returns: a newly created |
Creates a new AppChooserWidget
for applications
that can handle content of the given type.
Since: 3.0
setDefaultText
appChooserWidgetSetDefaultText Source #
:: (HasCallStack, MonadIO m, IsAppChooserWidget a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the text that is shown if there are not applications that can handle the content type.
setShowAll
appChooserWidgetSetShowAll Source #
:: (HasCallStack, MonadIO m, IsAppChooserWidget a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the app chooser should show all applications in a flat list.
Since: 3.0
setShowDefault
appChooserWidgetSetShowDefault Source #
:: (HasCallStack, MonadIO m, IsAppChooserWidget a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the app chooser should show the default handler for the content type in a separate section.
Since: 3.0
setShowFallback
appChooserWidgetSetShowFallback Source #
:: (HasCallStack, MonadIO m, IsAppChooserWidget a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the app chooser should show related applications for the content type in a separate section.
Since: 3.0
setShowOther
appChooserWidgetSetShowOther Source #
:: (HasCallStack, MonadIO m, IsAppChooserWidget a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the app chooser should show applications which are unrelated to the content type.
Since: 3.0
setShowRecommended
appChooserWidgetSetShowRecommended Source #
:: (HasCallStack, MonadIO m, IsAppChooserWidget a) | |
=> a |
|
-> Bool |
|
-> 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) Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
Set the value of the “show-all
” property.
When overloading is enabled, this is equivalent to
set
appChooserWidget [ #showAll:=
value ]
showDefault
The ::show-default 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) Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
Set the value of the “show-recommended
” property.
When overloading is enabled, this is equivalent to
set
appChooserWidget [ #showRecommended:=
value ]
Signals
applicationActivated
type AppChooserWidgetApplicationActivatedCallback Source #
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 () Source #
Type for the callback on the (unwrapped) C side.
afterAppChooserWidgetApplicationActivated :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetApplicationActivatedCallback -> m SignalHandlerId Source #
Connect a signal handler for the “application-activated
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
appChooserWidget #applicationActivated callback
genClosure_AppChooserWidgetApplicationActivated :: AppChooserWidgetApplicationActivatedCallback -> IO Closure Source #
Wrap the callback into a Closure
.
mk_AppChooserWidgetApplicationActivatedCallback :: C_AppChooserWidgetApplicationActivatedCallback -> IO (FunPtr C_AppChooserWidgetApplicationActivatedCallback) Source #
Generate a function pointer callable from C code, from a C_AppChooserWidgetApplicationActivatedCallback
.
noAppChooserWidgetApplicationActivatedCallback :: Maybe AppChooserWidgetApplicationActivatedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
AppChooserWidgetApplicationActivatedCallback
onAppChooserWidgetApplicationActivated :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetApplicationActivatedCallback -> m SignalHandlerId Source #
Connect a signal handler for the “application-activated
” 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 Source #
applicationSelected
type AppChooserWidgetApplicationSelectedCallback Source #
Emitted when an application item is selected from the widget's list.
type C_AppChooserWidgetApplicationSelectedCallback = Ptr () -> Ptr AppInfo -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
afterAppChooserWidgetApplicationSelected :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetApplicationSelectedCallback -> m SignalHandlerId Source #
Connect a signal handler for the “application-selected
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
appChooserWidget #applicationSelected callback
genClosure_AppChooserWidgetApplicationSelected :: AppChooserWidgetApplicationSelectedCallback -> IO Closure Source #
Wrap the callback into a Closure
.
mk_AppChooserWidgetApplicationSelectedCallback :: C_AppChooserWidgetApplicationSelectedCallback -> IO (FunPtr C_AppChooserWidgetApplicationSelectedCallback) Source #
Generate a function pointer callable from C code, from a C_AppChooserWidgetApplicationSelectedCallback
.
noAppChooserWidgetApplicationSelectedCallback :: Maybe AppChooserWidgetApplicationSelectedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
AppChooserWidgetApplicationSelectedCallback
onAppChooserWidgetApplicationSelected :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetApplicationSelectedCallback -> m SignalHandlerId Source #
Connect a signal handler for the “application-selected
” 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 Source #
populatePopup
type AppChooserWidgetPopulatePopupCallback Source #
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 () Source #
Type for the callback on the (unwrapped) C side.
afterAppChooserWidgetPopulatePopup :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetPopulatePopupCallback -> m SignalHandlerId Source #
Connect a signal handler for the “populate-popup
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
appChooserWidget #populatePopup callback
genClosure_AppChooserWidgetPopulatePopup :: AppChooserWidgetPopulatePopupCallback -> IO Closure Source #
Wrap the callback into a Closure
.
mk_AppChooserWidgetPopulatePopupCallback :: C_AppChooserWidgetPopulatePopupCallback -> IO (FunPtr C_AppChooserWidgetPopulatePopupCallback) Source #
Generate a function pointer callable from C code, from a C_AppChooserWidgetPopulatePopupCallback
.
noAppChooserWidgetPopulatePopupCallback :: Maybe AppChooserWidgetPopulatePopupCallback Source #
A convenience synonym for
.Nothing
:: Maybe
AppChooserWidgetPopulatePopupCallback
onAppChooserWidgetPopulatePopup :: (IsAppChooserWidget a, MonadIO m) => a -> AppChooserWidgetPopulatePopupCallback -> m SignalHandlerId Source #
Connect a signal handler for the “populate-popup
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
appChooserWidget #populatePopup callback