gi-gtk-4.0.6: Gtk bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Gtk.Objects.AppChooserWidget

Description

GtkAppChooserWidget 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.

GtkAppChooserWidget offers detailed control over what applications are shown, using the AppChooserWidget:showDefault, AppChooserWidget:showRecommended, AppChooserWidget:showFallback, AppChooserWidget:showOther and AppChooserWidget:showAll properties. See the AppChooser documentation for more information about these groups of applications.

To keep track of the selected application, use the AppChooserWidget::applicationSelected and AppChooserWidget::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

Instances details
Eq AppChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.AppChooserWidget

GObject AppChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.AppChooserWidget

ManagedPtrNewtype AppChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.AppChooserWidget

TypedObject AppChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.AppChooserWidget

Methods

glibType :: IO GType

HasParentTypes AppChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.AppChooserWidget

IsGValue (Maybe AppChooserWidget) Source #

Convert AppChooserWidget to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Gtk.Objects.AppChooserWidget

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe AppChooserWidget -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe AppChooserWidget)

type ParentTypes AppChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.AppChooserWidget

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

Instances details
(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.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, refresh, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAppInfo, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getContentType, getCssClasses, getCssName, getCursor, getData, getDefaultText, getDirection, getDisplay, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getShowAll, getShowDefault, getShowFallback, getShowOther, getShowRecommended, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDefaultText, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setSensitive, setShowAll, setShowDefault, setShowFallback, setShowOther, setShowRecommended, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.

getDefaultText

appChooserWidgetGetDefaultText Source #

Arguments

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

self: a GtkAppChooserWidget

-> m (Maybe Text)

Returns: the value of AppChooserWidget:defaultText

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

getShowAll

appChooserWidgetGetShowAll Source #

Arguments

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

self: a GtkAppChooserWidget

-> m Bool

Returns: the value of AppChooserWidget:showAll

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

getShowDefault

appChooserWidgetGetShowDefault Source #

Arguments

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

self: a GtkAppChooserWidget

-> m Bool

Returns: the value of AppChooserWidget:showDefault

Gets whether the app chooser should show the default handler for the content type in a separate section.

getShowFallback

appChooserWidgetGetShowFallback Source #

Arguments

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

self: a GtkAppChooserWidget

-> m Bool

Returns: the value of AppChooserWidget:showFallback

Gets whether the app chooser should show related applications for the content type in a separate section.

getShowOther

appChooserWidgetGetShowOther Source #

Arguments

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

self: a GtkAppChooserWidget

-> m Bool

Returns: the value of AppChooserWidget:showOther

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

getShowRecommended

appChooserWidgetGetShowRecommended Source #

Arguments

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

self: a GtkAppChooserWidget

-> m Bool

Returns: the value of AppChooserWidget:showRecommended

Gets whether the app chooser should show recommended applications for the content type in a separate section.

new

appChooserWidgetNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

contentType: the content type to show applications for

-> m AppChooserWidget

Returns: a newly created GtkAppChooserWidget

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

setDefaultText

appChooserWidgetSetDefaultText Source #

Arguments

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

self: a GtkAppChooserWidget

-> Text

text: the new value for AppChooserWidget:defaultText

-> 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 GtkAppChooserWidget

-> Bool

setting: the new value for AppChooserWidget:showAll

-> m () 

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

setShowDefault

appChooserWidgetSetShowDefault Source #

Arguments

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

self: a GtkAppChooserWidget

-> Bool

setting: the new value for AppChooserWidget:showDefault

-> m () 

Sets whether the app chooser should show the default handler for the content type in a separate section.

setShowFallback

appChooserWidgetSetShowFallback Source #

Arguments

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

self: a GtkAppChooserWidget

-> Bool

setting: the new value for AppChooserWidget:showFallback

-> m () 

Sets whether the app chooser should show related applications for the content type in a separate section.

setShowOther

appChooserWidgetSetShowOther Source #

Arguments

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

self: a GtkAppChooserWidget

-> Bool

setting: the new value for AppChooserWidget:showOther

-> m () 

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

setShowRecommended

appChooserWidgetSetShowRecommended Source #

Arguments

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

self: a GtkAppChooserWidget

-> Bool

setting: the new value for AppChooserWidget:showRecommended

-> m () 

Sets whether the app chooser should show recommended applications for the content type in a separate section.

Properties

defaultText

The text that appears in the widget when there are no applications for the given content type.

constructAppChooserWidgetDefaultText :: (IsAppChooserWidget o, MonadIO m) => Text -> m (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 (Maybe 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 True, the app chooser presents all applications in a single list, without subsections for default, recommended or related applications.

constructAppChooserWidgetShowAll :: (IsAppChooserWidget o, MonadIO m) => Bool -> m (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

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, MonadIO m) => Bool -> m (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

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, MonadIO m) => Bool -> m (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

Determines whether the app chooser should show a section for other applications.

constructAppChooserWidgetShowOther :: (IsAppChooserWidget o, MonadIO m) => Bool -> m (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

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, MonadIO m) => Bool -> m (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 GAppInfo

-> 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.

afterAppChooserWidgetApplicationActivated :: (IsAppChooserWidget a, MonadIO m) => a -> ((?self :: 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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onAppChooserWidgetApplicationActivated :: (IsAppChooserWidget a, MonadIO m) => a -> ((?self :: 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 GAppInfo

-> IO () 

Emitted when an application item is selected from the widget's list.

afterAppChooserWidgetApplicationSelected :: (IsAppChooserWidget a, MonadIO m) => a -> ((?self :: 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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onAppChooserWidgetApplicationSelected :: (IsAppChooserWidget a, MonadIO m) => a -> ((?self :: 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