GI.Gtk.Objects.LockButton

GtkLockButton is a widget to obtain and revoke authorizations needed to operate the controls.

It is typically used in preference dialogs or control panels.

The required authorization is represented by a GPermission object. Concrete implementations of GPermission may use PolicyKit or some other authorization framework. To obtain a PolicyKit-based GPermission, use polkit_permission_new().

If the user is not currently allowed to perform the action, but can obtain the permission, the widget looks like this:

and the user can click the button to request the permission. Depending on the platform, this may pop up an authentication dialog or ask the user to authenticate in some other way. Once the user has obtained the permission, the widget changes to this:

and the permission can be dropped again by clicking the button. If the user is not able to obtain the permission at all, the widget looks like this:

If the user has the permission and cannot drop it, the button is hidden.

The text (and tooltips) that are shown in the various cases can be adjusted with the LockButton:textLock, LockButton:textUnlock, LockButton:tooltipLock, LockButton:tooltipUnlock and LockButton:tooltipNotAuthorized properties.

Exported types

newtype LockButton

Memory-managed wrapper type.

Constructors

LockButton (ManagedPtr LockButton)

Instances

Eq LockButton

Defined in GI.Gtk.Objects.LockButton

Methods

(==) :: LockButton -> LockButton -> Bool

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

GObject LockButton

Defined in GI.Gtk.Objects.LockButton

ManagedPtrNewtype LockButton

Defined in GI.Gtk.Objects.LockButton

Methods

toManagedPtr :: LockButton -> ManagedPtr LockButton

TypedObject LockButton

Defined in GI.Gtk.Objects.LockButton

Methods

glibType :: IO GType

HasParentTypes LockButton

Defined in GI.Gtk.Objects.LockButton

IsGValue (Maybe LockButton)

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

Defined in GI.Gtk.Objects.LockButton

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes LockButton

Defined in GI.Gtk.Objects.LockButton

type ParentTypes LockButton = '[Button, Widget, Object, Accessible, Actionable, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf LockButton o) => IsLockButton o

Type class for types which can be safely cast to LockButton, for instance with toLockButton.

Instances

(GObject o, IsDescendantOf LockButton o) => IsLockButton o

Defined in GI.Gtk.Objects.LockButton

toLockButton :: (MonadIO m, IsLockButton o) => o -> m LockButton

Cast to LockButton, 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, 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, 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, getActionName, getActionTargetValue, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasFrame, getHasTooltip, getHeight, getHexpand, getHexpandSet, getIconName, getLabel, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPermission, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getUseUnderline, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setActionName, setActionTargetValue, setCanFocus, setCanTarget, setChild, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDetailedActionName, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasFrame, setHasTooltip, setHexpand, setHexpandSet, setIconName, setLabel, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setPermission, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible.

getPermission

lockButtonGetPermission

Arguments

:: (HasCallStack, MonadIO m, IsLockButton a)

=> a

button: a GtkLockButton

-> m (Maybe Permission)

Returns: the GPermission of button

Obtains the GPermission object that controls button.

new

lockButtonNew

Arguments

:: (HasCallStack, MonadIO m, IsPermission a)

=> Maybe a

permission: a GPermission

-> m LockButton

Returns: a new GtkLockButton

Creates a new lock button which reflects the permission.

setPermission

lockButtonSetPermission

Arguments

:: (HasCallStack, MonadIO m, IsLockButton a, IsPermission b)

=> a

button: a GtkLockButton

-> Maybe b

permission: a GPermission object

-> m ()

Sets the GPermission object that controls button.

Properties

permission

The `GPermission object controlling this button.

clearLockButtonPermission :: (MonadIO m, IsLockButton o) => o -> m ()

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

clear #permission

constructLockButtonPermission :: (IsLockButton o, MonadIO m, IsPermission a) => a -> m (GValueConstruct o)

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

getLockButtonPermission :: (MonadIO m, IsLockButton o) => o -> m (Maybe Permission)

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

get lockButton #permission

setLockButtonPermission :: (MonadIO m, IsLockButton o, IsPermission a) => o -> a -> m ()

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

set lockButton [ #permission := value ]

textLock

The text to display when prompting the user to lock.

clearLockButtonTextLock :: (MonadIO m, IsLockButton o) => o -> m ()

Set the value of the “text-lock” property to Nothing. When overloading is enabled, this is equivalent to

clear #textLock

constructLockButtonTextLock :: (IsLockButton o, MonadIO m) => Text -> m (GValueConstruct o)

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

getLockButtonTextLock :: (MonadIO m, IsLockButton o) => o -> m (Maybe Text)

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

get lockButton #textLock

setLockButtonTextLock :: (MonadIO m, IsLockButton o) => o -> Text -> m ()

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

set lockButton [ #textLock := value ]

textUnlock

The text to display when prompting the user to unlock.

clearLockButtonTextUnlock :: (MonadIO m, IsLockButton o) => o -> m ()

Set the value of the “text-unlock” property to Nothing. When overloading is enabled, this is equivalent to

clear #textUnlock

constructLockButtonTextUnlock :: (IsLockButton o, MonadIO m) => Text -> m (GValueConstruct o)

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

getLockButtonTextUnlock :: (MonadIO m, IsLockButton o) => o -> m (Maybe Text)

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

get lockButton #textUnlock

setLockButtonTextUnlock :: (MonadIO m, IsLockButton o) => o -> Text -> m ()

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

set lockButton [ #textUnlock := value ]

tooltipLock

The tooltip to display when prompting the user to lock.

clearLockButtonTooltipLock :: (MonadIO m, IsLockButton o) => o -> m ()

Set the value of the “tooltip-lock” property to Nothing. When overloading is enabled, this is equivalent to

clear #tooltipLock

constructLockButtonTooltipLock :: (IsLockButton o, MonadIO m) => Text -> m (GValueConstruct o)

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

getLockButtonTooltipLock :: (MonadIO m, IsLockButton o) => o -> m (Maybe Text)

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

get lockButton #tooltipLock

setLockButtonTooltipLock :: (MonadIO m, IsLockButton o) => o -> Text -> m ()

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

set lockButton [ #tooltipLock := value ]

tooltipNotAuthorized

The tooltip to display when the user cannot obtain authorization.

clearLockButtonTooltipNotAuthorized :: (MonadIO m, IsLockButton o) => o -> m ()

Set the value of the “tooltip-not-authorized” property to Nothing. When overloading is enabled, this is equivalent to

clear #tooltipNotAuthorized

constructLockButtonTooltipNotAuthorized :: (IsLockButton o, MonadIO m) => Text -> m (GValueConstruct o)

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

getLockButtonTooltipNotAuthorized :: (MonadIO m, IsLockButton o) => o -> m (Maybe Text)

Get the value of the “tooltip-not-authorized” property. When overloading is enabled, this is equivalent to

get lockButton #tooltipNotAuthorized

setLockButtonTooltipNotAuthorized :: (MonadIO m, IsLockButton o) => o -> Text -> m ()

Set the value of the “tooltip-not-authorized” property. When overloading is enabled, this is equivalent to

set lockButton [ #tooltipNotAuthorized := value ]

tooltipUnlock

The tooltip to display when prompting the user to unlock.

clearLockButtonTooltipUnlock :: (MonadIO m, IsLockButton o) => o -> m ()

Set the value of the “tooltip-unlock” property to Nothing. When overloading is enabled, this is equivalent to

clear #tooltipUnlock

constructLockButtonTooltipUnlock :: (IsLockButton o, MonadIO m) => Text -> m (GValueConstruct o)

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

getLockButtonTooltipUnlock :: (MonadIO m, IsLockButton o) => o -> m (Maybe Text)

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

get lockButton #tooltipUnlock

setLockButtonTooltipUnlock :: (MonadIO m, IsLockButton o) => o -> Text -> m ()

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

set lockButton [ #tooltipUnlock := value ]