GI.Gtk.Objects.LockButton

GtkLockButton is a widget that can be used in control panels or preference dialogs to allow users to obtain and revoke authorizations needed to operate the controls. The required authorization is represented by a Permission object. Concrete implementations of Permission may use PolicyKit or some other authorization framework. To obtain a PolicyKit-based Permission, 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:text-lock, LockButton:text-unlock, LockButton:tooltip-lock, LockButton:tooltip-unlock and LockButton:tooltip-not-authorized properties.

Exported types

newtype LockButton

Constructors

LockButton (ManagedPtr LockButton)

Instances

GObject LockButton

Methods

gobjectType :: LockButton -> IO GType

IsImplementorIface LockButton

IsObject LockButton

IsWidget LockButton

IsContainer LockButton

IsButton LockButton

IsBin LockButton

IsBuildable LockButton

IsActivatable LockButton

IsActionable LockButton

IsLockButton LockButton

class GObject o => IsLockButton o

Instances

(GObject a, UnknownAncestorError Constraint LockButton a) => IsLockButton a

IsLockButton LockButton

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

noLockButton :: Maybe LockButton

Methods

getPermission

lockButtonGetPermission

Arguments

:: (HasCallStack, MonadIO m, IsLockButton a)

=> a

button: a LockButton

-> m Permission

Returns: the Permission of button

Obtains the Permission object that controls button.

Since: 3.2

new

lockButtonNew

Arguments

:: (HasCallStack, MonadIO m, IsPermission a)

=> Maybe a

permission: a Permission

-> m LockButton

Returns: a new LockButton

Creates a new lock button which reflects the permission.

Since: 3.2

setPermission

lockButtonSetPermission

Arguments

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

=> a

button: a LockButton

-> Maybe b

permission: a Permission object, or Nothing

-> m ()

Sets the Permission object that controls button.

Since: 3.2

Properties

permission

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

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

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

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

textLock

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

constructLockButtonTextLock :: IsLockButton o => Text -> IO (GValueConstruct o)

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

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

textUnlock

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

constructLockButtonTextUnlock :: IsLockButton o => Text -> IO (GValueConstruct o)

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

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

tooltipLock

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

constructLockButtonTooltipLock :: IsLockButton o => Text -> IO (GValueConstruct o)

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

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

tooltipNotAuthorized

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

constructLockButtonTooltipNotAuthorized :: IsLockButton o => Text -> IO (GValueConstruct o)

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

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

tooltipUnlock

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

constructLockButtonTooltipUnlock :: IsLockButton o => Text -> IO (GValueConstruct o)

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

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