gi-gtk-3.0.32: Gtk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.AppChooserWidget

Contents

Description

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

tAppChooserWidget offers detailed control over what applications are shown, using the tAppChooserWidget:show-default, tAppChooserWidget:show-recommended, tAppChooserWidget:show-fallback, tAppChooserWidget:show-other and tAppChooserWidget:show-all properties. See the tAppChooser 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.

Synopsis

Exported types

newtype AppChooserWidget Source #

Memory-managed wrapper type.

Constructors

AppChooserWidget (ManagedPtr AppChooserWidget) 
Instances
Eq AppChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.AppChooserWidget

GObject AppChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.AppChooserWidget

Methods

gobjectType :: IO GType

IsGValue AppChooserWidget Source #

Convert AppChooserWidget to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Gtk.Objects.AppChooserWidget

Methods

toGValue :: AppChooserWidget -> IO GValue

fromGValue :: GValue -> IO AppChooserWidget

HasParentTypes AppChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.AppChooserWidget

type ParentTypes AppChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.AppChooserWidget

type ParentTypes AppChooserWidget = Box ': (Container ': (Widget ': (Object ': (ImplementorIface ': (AppChooser ': (Buildable ': (Orientable ': ([] :: [Type]))))))))

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

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

Instances
(GObject o, IsDescendantOf AppChooserWidget o) => IsAppChooserWidget o Source # 
Instance details

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

Overloaded methods

getDefaultText

appChooserWidgetGetDefaultText Source #

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a) 
=> a

self: a tAppChooserWidget

-> m Text

Returns: the value of tAppChooserWidget:default-text

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

Since: 3.0

getShowAll

appChooserWidgetGetShowAll Source #

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a) 
=> a

self: a tAppChooserWidget

-> m Bool

Returns: the value of tAppChooserWidget:show-all

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

Since: 3.0

getShowDefault

appChooserWidgetGetShowDefault Source #

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a) 
=> a

self: a tAppChooserWidget

-> m Bool

Returns: the value of tAppChooserWidget:show-default

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

Since: 3.0

getShowFallback

appChooserWidgetGetShowFallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a) 
=> a

self: a tAppChooserWidget

-> m Bool

Returns: the value of tAppChooserWidget:show-fallback

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

Since: 3.0

getShowOther

appChooserWidgetGetShowOther Source #

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a) 
=> a

self: a tAppChooserWidget

-> m Bool

Returns: the value of tAppChooserWidget:show-other

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

Since: 3.0

getShowRecommended

appChooserWidgetGetShowRecommended Source #

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a) 
=> a

self: a tAppChooserWidget

-> m Bool

Returns: the value of tAppChooserWidget:show-recommended

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

Since: 3.0

new

appChooserWidgetNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

contentType: the content type to show applications for

-> m AppChooserWidget

Returns: a newly created tAppChooserWidget

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

Since: 3.0

setDefaultText

appChooserWidgetSetDefaultText Source #

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a) 
=> a

self: a tAppChooserWidget

-> Text

text: the new value for tAppChooserWidget:default-text

-> m () 

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

setShowAll

appChooserWidgetSetShowAll Source #

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a) 
=> a

self: a tAppChooserWidget

-> Bool

setting: the new value for tAppChooserWidget:show-all

-> m () 

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

Since: 3.0

setShowDefault

appChooserWidgetSetShowDefault Source #

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a) 
=> a

self: a tAppChooserWidget

-> Bool

setting: the new value for tAppChooserWidget: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 Source #

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a) 
=> a

self: a tAppChooserWidget

-> Bool

setting: the new value for tAppChooserWidget: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 Source #

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a) 
=> a

self: a tAppChooserWidget

-> Bool

setting: the new value for tAppChooserWidget:show-other

-> m () 

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

Since: 3.0

setShowRecommended

appChooserWidgetSetShowRecommended Source #

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserWidget a) 
=> a

self: a tAppChooserWidget

-> Bool

setting: the new value for tAppChooserWidget: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 tAppChooserWidget: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 tAppChooserWidget: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 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) 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 tAppChooserWidget: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 tAppChooserWidget: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 tAppChooserWidget: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 #

Arguments

 = AppInfo

application: the activated tAppInfo

-> 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 () 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 applicationActivated signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after appChooserWidget #applicationActivated callback

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

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

applicationSelected

type AppChooserWidgetApplicationSelectedCallback Source #

Arguments

 = AppInfo

application: the selected tAppInfo

-> IO () 

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 applicationSelected signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after appChooserWidget #applicationSelected callback

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

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

populatePopup

type AppChooserWidgetPopulatePopupCallback Source #

Arguments

 = Menu

menu: the tMenu to populate

-> AppInfo

application: the current tAppInfo

-> IO () 

Emitted when a context menu is about to popup over an application item. Clients can insert menu items into the provided tMenu 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 populatePopup signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after appChooserWidget #populatePopup callback

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

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