GI.Gtk.Objects.AppChooserButton

The GtkAppChooserButton lets the user select an application.

Initially, a GtkAppChooserButton selects the first application in its list, which will either be the most-recently used application or, if AppChooserButton:showDefaultItem is True, the default application.

The list of applications shown in a GtkAppChooserButton includes the recommended applications for the given content type. When AppChooserButton:showDefaultItem is set, the default application is also included. To let the user chooser other applications, you can set the AppChooserButton:showDialogItem 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::customItemActivated signal to be emitted when they are selected.

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

CSS nodes

GtkAppChooserButton has a single CSS node with the name “appchooserbutton”.

Exported types

newtype AppChooserButton

Memory-managed wrapper type.

Constructors

AppChooserButton (ManagedPtr AppChooserButton)

Instances

Eq AppChooserButton

Defined in GI.Gtk.Objects.AppChooserButton

Methods

(==) :: AppChooserButton -> AppChooserButton -> Bool

(/=) :: AppChooserButton -> AppChooserButton -> Bool

GObject AppChooserButton

Defined in GI.Gtk.Objects.AppChooserButton

ManagedPtrNewtype AppChooserButton

Defined in GI.Gtk.Objects.AppChooserButton

Methods

toManagedPtr :: AppChooserButton -> ManagedPtr AppChooserButton

TypedObject AppChooserButton

Defined in GI.Gtk.Objects.AppChooserButton

Methods

glibType :: IO GType

HasParentTypes AppChooserButton

Defined in GI.Gtk.Objects.AppChooserButton

IsGValue (Maybe AppChooserButton)

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

Defined in GI.Gtk.Objects.AppChooserButton

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes AppChooserButton

Defined in GI.Gtk.Objects.AppChooserButton

type ParentTypes AppChooserButton = '[Widget, Object, Accessible, AppChooser, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf AppChooserButton o) => IsAppChooserButton o

Type class for types which can be safely cast to AppChooserButton, for instance with toAppChooserButton.

Instances

(GObject o, IsDescendantOf AppChooserButton o) => IsAppChooserButton o

Defined in GI.Gtk.Objects.AppChooserButton

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

Cast to AppChooserButton, 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

Methods

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, appendCustomItem, appendSeparator, 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, getDirection, getDisplay, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeading, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getModal, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getShowDefaultItem, getShowDialogItem, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setActiveCustomItem, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHeading, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setModal, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setSensitive, setShowDefaultItem, setShowDialogItem, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.

appendCustomItem

appChooserButtonAppendCustomItem

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a, IsIcon b)

=> a

self: a GtkAppChooserButton

-> 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::customItemActivated signal, to add a callback for the activation of a particular custom item in the list.

See also appChooserButtonAppendSeparator.

appendSeparator

appChooserButtonAppendSeparator

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a GtkAppChooserButton

-> m ()

Appends a separator to the list of applications that is shown in the popup.

getHeading

appChooserButtonGetHeading

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a GtkAppChooserButton

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

getModal

appChooserButtonGetModal

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a GtkAppChooserButton

-> m Bool

Returns: True if the dialog is modal

Gets whether the dialog is modal.

getShowDefaultItem

appChooserButtonGetShowDefaultItem

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a GtkAppChooserButton

-> m Bool

Returns: the value of AppChooserButton:showDefaultItem

Returns whether the dropdown menu should show the default application at the top.

getShowDialogItem

appChooserButtonGetShowDialogItem

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a GtkAppChooserButton

-> m Bool

Returns: the value of AppChooserButton:showDialogItem

Returns whether the dropdown menu shows an item for a GtkAppChooserDialog.

new

appChooserButtonNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

contentType: the content type to show applications for

-> m AppChooserButton

Returns: a newly created GtkAppChooserButton

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

setActiveCustomItem

appChooserButtonSetActiveCustomItem

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a GtkAppChooserButton

-> Text

name: the name of the custom item

-> m ()

Selects a custom item.

See appChooserButtonAppendCustomItem.

Use appChooserRefresh to bring the selection to its initial state.

setHeading

appChooserButtonSetHeading

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a GtkAppChooserButton

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

setModal

appChooserButtonSetModal

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a GtkAppChooserButton

-> Bool

modal: True to make the dialog modal

-> m ()

Sets whether the dialog should be modal.

setShowDefaultItem

appChooserButtonSetShowDefaultItem

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a GtkAppChooserButton

-> Bool

setting: the new value for AppChooserButton:showDefaultItem

-> m ()

Sets whether the dropdown menu of this button should show the default application for the given content type at top.

setShowDialogItem

appChooserButtonSetShowDialogItem

Arguments

:: (HasCallStack, MonadIO m, IsAppChooserButton a)

=> a

self: a GtkAppChooserButton

-> Bool

setting: the new value for AppChooserButton:showDialogItem

-> m ()

Sets whether the dropdown menu of this button should show an entry to trigger a GtkAppChooserDialog.

Properties

heading

The text to show at the top of the dialog that can be opened from the button.

The string may contain Pango markup.

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

Construct a GValueConstruct with valid value for the “heading” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “heading” property. When overloading is enabled, this is equivalent to

get appChooserButton #heading

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

Set the value of the “heading” property. When overloading is enabled, this is equivalent to

set appChooserButton [ #heading := value ]

modal

Whether the app chooser dialog should be modal.

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

Construct a GValueConstruct with valid value for the “modal” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “modal” property. When overloading is enabled, this is equivalent to

get appChooserButton #modal

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

Set the value of the “modal” property. When overloading is enabled, this is equivalent to

set appChooserButton [ #modal := value ]

showDefaultItem

Determines whether the dropdown menu shows the default application on top for the provided content type.

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

Construct a GValueConstruct with valid value for the “show-default-item” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “show-default-item” property. When overloading is enabled, this is equivalent to

get appChooserButton #showDefaultItem

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

Set the value of the “show-default-item” property. When overloading is enabled, this is equivalent to

set appChooserButton [ #showDefaultItem := value ]

showDialogItem

Determines whether the dropdown menu shows an item to open a GtkAppChooserDialog.

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

Construct a GValueConstruct with valid value for the “show-dialog-item” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “show-dialog-item” property. When overloading is enabled, this is equivalent to

get appChooserButton #showDialogItem

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

Set the value of the “show-dialog-item” property. When overloading is enabled, this is equivalent to

set appChooserButton [ #showDialogItem := value ]

Signals

activate

type AppChooserButtonActivateCallback = IO ()

Emitted to when the button is activated.

The ::activate signal on GtkAppChooserButton is an action signal and emitting it causes the button to pop up its dialog.

Since: 4.4

afterAppChooserButtonActivate :: (IsAppChooserButton a, MonadIO m) => a -> ((?self :: a) => AppChooserButtonActivateCallback) -> m SignalHandlerId

Connect a signal handler for the activate signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after appChooserButton #activate 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.

onAppChooserButtonActivate :: (IsAppChooserButton a, MonadIO m) => a -> ((?self :: a) => AppChooserButtonActivateCallback) -> m SignalHandlerId

Connect a signal handler for the activate signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on appChooserButton #activate callback

changed

type AppChooserButtonChangedCallback = IO ()

Emitted when the active application changes.

afterAppChooserButtonChanged :: (IsAppChooserButton a, MonadIO m) => a -> ((?self :: a) => AppChooserButtonChangedCallback) -> m SignalHandlerId

Connect a signal handler for the changed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after appChooserButton #changed 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.

onAppChooserButtonChanged :: (IsAppChooserButton a, MonadIO m) => a -> ((?self :: a) => AppChooserButtonChangedCallback) -> m SignalHandlerId

Connect a signal handler for the changed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on appChooserButton #changed callback

customItemActivated

type AppChooserButtonCustomItemActivatedCallback

Arguments

 = Text

itemName: the name of the activated item

-> IO ()

Emitted when a custom item is activated.

Use appChooserButtonAppendCustomItem, to add custom items.

afterAppChooserButtonCustomItemActivated :: (IsAppChooserButton a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => AppChooserButtonCustomItemActivatedCallback) -> m SignalHandlerId

Connect a signal handler for the customItemActivated signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after appChooserButton #customItemActivated callback

This signal admits a optional parameter detail. If it's not Nothing, we will connect to “custom-item-activated::detail” instead.

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.

onAppChooserButtonCustomItemActivated :: (IsAppChooserButton a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => AppChooserButtonCustomItemActivatedCallback) -> m SignalHandlerId

Connect a signal handler for the customItemActivated signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on appChooserButton #customItemActivated callback

This signal admits a optional parameter detail. If it's not Nothing, we will connect to “custom-item-activated::detail” instead.