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

((~) * info (ResolveLockButtonMethod t LockButton), MethodInfo * info LockButton p) => IsLabel t (LockButton -> p)

Methods

fromLabel :: Proxy# Symbol t -> LockButton -> p

((~) * info (ResolveLockButtonMethod t LockButton), MethodInfo * info LockButton p) => IsLabelProxy t (LockButton -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> LockButton -> p

HasAttributeList * LockButton

type AttributeList LockButton

type AttributeList LockButton

type SignalList LockButton

type SignalList LockButton

class GObject o => IsLockButton o

Instances

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

IsLockButton LockButton

toLockButton :: IsLockButton o => o -> IO LockButton

noLockButton :: Maybe LockButton

Methods

getPermission

data LockButtonGetPermissionMethodInfo

Instances

((~) * signature (m Permission), MonadIO m, IsLockButton a) => MethodInfo * LockButtonGetPermissionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy LockButtonGetPermissionMethodInfo a -> signature -> s

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

data LockButtonSetPermissionMethodInfo

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsLockButton a, IsPermission b) => MethodInfo * LockButtonSetPermissionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy LockButtonSetPermissionMethodInfo a -> signature -> s

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

data LockButtonPermissionPropertyInfo

Instances

AttrInfo LockButtonPermissionPropertyInfo

Associated Types

type AttrAllowedOps LockButtonPermissionPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint LockButtonPermissionPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint LockButtonPermissionPropertyInfo :: * -> Constraint

type AttrGetType LockButtonPermissionPropertyInfo :: *

type AttrLabel LockButtonPermissionPropertyInfo :: Symbol

type AttrOrigin LockButtonPermissionPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint LockButtonPermissionPropertyInfo o => Proxy * LockButtonPermissionPropertyInfo -> o -> IO (AttrGetType LockButtonPermissionPropertyInfo)

attrSet :: (AttrBaseTypeConstraint LockButtonPermissionPropertyInfo o, AttrSetTypeConstraint LockButtonPermissionPropertyInfo b) => Proxy * LockButtonPermissionPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint LockButtonPermissionPropertyInfo o => Proxy * LockButtonPermissionPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint LockButtonPermissionPropertyInfo o, AttrSetTypeConstraint LockButtonPermissionPropertyInfo b) => Proxy * LockButtonPermissionPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin LockButtonPermissionPropertyInfo

type AttrOrigin LockButtonPermissionPropertyInfo = LockButton

type AttrLabel LockButtonPermissionPropertyInfo

type AttrLabel LockButtonPermissionPropertyInfo = "permission"

type AttrGetType LockButtonPermissionPropertyInfo

type AttrGetType LockButtonPermissionPropertyInfo = Permission

type AttrBaseTypeConstraint LockButtonPermissionPropertyInfo

type AttrBaseTypeConstraint LockButtonPermissionPropertyInfo = IsLockButton

type AttrSetTypeConstraint LockButtonPermissionPropertyInfo

type AttrSetTypeConstraint LockButtonPermissionPropertyInfo = IsPermission

type AttrAllowedOps LockButtonPermissionPropertyInfo

type AttrAllowedOps LockButtonPermissionPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

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

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

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

lockButtonPermission :: AttrLabelProxy "permission"

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

textLock

data LockButtonTextLockPropertyInfo

Instances

AttrInfo LockButtonTextLockPropertyInfo

Associated Types

type AttrAllowedOps LockButtonTextLockPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint LockButtonTextLockPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint LockButtonTextLockPropertyInfo :: * -> Constraint

type AttrGetType LockButtonTextLockPropertyInfo :: *

type AttrLabel LockButtonTextLockPropertyInfo :: Symbol

type AttrOrigin LockButtonTextLockPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint LockButtonTextLockPropertyInfo o => Proxy * LockButtonTextLockPropertyInfo -> o -> IO (AttrGetType LockButtonTextLockPropertyInfo)

attrSet :: (AttrBaseTypeConstraint LockButtonTextLockPropertyInfo o, AttrSetTypeConstraint LockButtonTextLockPropertyInfo b) => Proxy * LockButtonTextLockPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint LockButtonTextLockPropertyInfo o => Proxy * LockButtonTextLockPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint LockButtonTextLockPropertyInfo o, AttrSetTypeConstraint LockButtonTextLockPropertyInfo b) => Proxy * LockButtonTextLockPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin LockButtonTextLockPropertyInfo

type AttrOrigin LockButtonTextLockPropertyInfo = LockButton

type AttrLabel LockButtonTextLockPropertyInfo

type AttrLabel LockButtonTextLockPropertyInfo = "text-lock"

type AttrGetType LockButtonTextLockPropertyInfo

type AttrGetType LockButtonTextLockPropertyInfo = Maybe Text

type AttrBaseTypeConstraint LockButtonTextLockPropertyInfo

type AttrBaseTypeConstraint LockButtonTextLockPropertyInfo = IsLockButton

type AttrSetTypeConstraint LockButtonTextLockPropertyInfo

type AttrSetTypeConstraint LockButtonTextLockPropertyInfo = * ~ Text

type AttrAllowedOps LockButtonTextLockPropertyInfo

type AttrAllowedOps LockButtonTextLockPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

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

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

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

lockButtonTextLock :: AttrLabelProxy "textLock"

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

textUnlock

data LockButtonTextUnlockPropertyInfo

Instances

AttrInfo LockButtonTextUnlockPropertyInfo

Associated Types

type AttrAllowedOps LockButtonTextUnlockPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint LockButtonTextUnlockPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint LockButtonTextUnlockPropertyInfo :: * -> Constraint

type AttrGetType LockButtonTextUnlockPropertyInfo :: *

type AttrLabel LockButtonTextUnlockPropertyInfo :: Symbol

type AttrOrigin LockButtonTextUnlockPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint LockButtonTextUnlockPropertyInfo o => Proxy * LockButtonTextUnlockPropertyInfo -> o -> IO (AttrGetType LockButtonTextUnlockPropertyInfo)

attrSet :: (AttrBaseTypeConstraint LockButtonTextUnlockPropertyInfo o, AttrSetTypeConstraint LockButtonTextUnlockPropertyInfo b) => Proxy * LockButtonTextUnlockPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint LockButtonTextUnlockPropertyInfo o => Proxy * LockButtonTextUnlockPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint LockButtonTextUnlockPropertyInfo o, AttrSetTypeConstraint LockButtonTextUnlockPropertyInfo b) => Proxy * LockButtonTextUnlockPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin LockButtonTextUnlockPropertyInfo

type AttrOrigin LockButtonTextUnlockPropertyInfo = LockButton

type AttrLabel LockButtonTextUnlockPropertyInfo

type AttrLabel LockButtonTextUnlockPropertyInfo = "text-unlock"

type AttrGetType LockButtonTextUnlockPropertyInfo

type AttrGetType LockButtonTextUnlockPropertyInfo = Maybe Text

type AttrBaseTypeConstraint LockButtonTextUnlockPropertyInfo

type AttrBaseTypeConstraint LockButtonTextUnlockPropertyInfo = IsLockButton

type AttrSetTypeConstraint LockButtonTextUnlockPropertyInfo

type AttrSetTypeConstraint LockButtonTextUnlockPropertyInfo = * ~ Text

type AttrAllowedOps LockButtonTextUnlockPropertyInfo

type AttrAllowedOps LockButtonTextUnlockPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

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

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

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

lockButtonTextUnlock :: AttrLabelProxy "textUnlock"

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

tooltipLock

data LockButtonTooltipLockPropertyInfo

Instances

AttrInfo LockButtonTooltipLockPropertyInfo

Associated Types

type AttrAllowedOps LockButtonTooltipLockPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint LockButtonTooltipLockPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint LockButtonTooltipLockPropertyInfo :: * -> Constraint

type AttrGetType LockButtonTooltipLockPropertyInfo :: *

type AttrLabel LockButtonTooltipLockPropertyInfo :: Symbol

type AttrOrigin LockButtonTooltipLockPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint LockButtonTooltipLockPropertyInfo o => Proxy * LockButtonTooltipLockPropertyInfo -> o -> IO (AttrGetType LockButtonTooltipLockPropertyInfo)

attrSet :: (AttrBaseTypeConstraint LockButtonTooltipLockPropertyInfo o, AttrSetTypeConstraint LockButtonTooltipLockPropertyInfo b) => Proxy * LockButtonTooltipLockPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint LockButtonTooltipLockPropertyInfo o => Proxy * LockButtonTooltipLockPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint LockButtonTooltipLockPropertyInfo o, AttrSetTypeConstraint LockButtonTooltipLockPropertyInfo b) => Proxy * LockButtonTooltipLockPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin LockButtonTooltipLockPropertyInfo

type AttrOrigin LockButtonTooltipLockPropertyInfo = LockButton

type AttrLabel LockButtonTooltipLockPropertyInfo

type AttrLabel LockButtonTooltipLockPropertyInfo = "tooltip-lock"

type AttrGetType LockButtonTooltipLockPropertyInfo

type AttrGetType LockButtonTooltipLockPropertyInfo = Maybe Text

type AttrBaseTypeConstraint LockButtonTooltipLockPropertyInfo

type AttrBaseTypeConstraint LockButtonTooltipLockPropertyInfo = IsLockButton

type AttrSetTypeConstraint LockButtonTooltipLockPropertyInfo

type AttrSetTypeConstraint LockButtonTooltipLockPropertyInfo = * ~ Text

type AttrAllowedOps LockButtonTooltipLockPropertyInfo

type AttrAllowedOps LockButtonTooltipLockPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

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

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

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

lockButtonTooltipLock :: AttrLabelProxy "tooltipLock"

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

tooltipNotAuthorized

data LockButtonTooltipNotAuthorizedPropertyInfo

Instances

AttrInfo LockButtonTooltipNotAuthorizedPropertyInfo

Associated Types

type AttrAllowedOps LockButtonTooltipNotAuthorizedPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint LockButtonTooltipNotAuthorizedPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint LockButtonTooltipNotAuthorizedPropertyInfo :: * -> Constraint

type AttrGetType LockButtonTooltipNotAuthorizedPropertyInfo :: *

type AttrLabel LockButtonTooltipNotAuthorizedPropertyInfo :: Symbol

type AttrOrigin LockButtonTooltipNotAuthorizedPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint LockButtonTooltipNotAuthorizedPropertyInfo o => Proxy * LockButtonTooltipNotAuthorizedPropertyInfo -> o -> IO (AttrGetType LockButtonTooltipNotAuthorizedPropertyInfo)

attrSet :: (AttrBaseTypeConstraint LockButtonTooltipNotAuthorizedPropertyInfo o, AttrSetTypeConstraint LockButtonTooltipNotAuthorizedPropertyInfo b) => Proxy * LockButtonTooltipNotAuthorizedPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint LockButtonTooltipNotAuthorizedPropertyInfo o => Proxy * LockButtonTooltipNotAuthorizedPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint LockButtonTooltipNotAuthorizedPropertyInfo o, AttrSetTypeConstraint LockButtonTooltipNotAuthorizedPropertyInfo b) => Proxy * LockButtonTooltipNotAuthorizedPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin LockButtonTooltipNotAuthorizedPropertyInfo

type AttrOrigin LockButtonTooltipNotAuthorizedPropertyInfo = LockButton

type AttrLabel LockButtonTooltipNotAuthorizedPropertyInfo

type AttrLabel LockButtonTooltipNotAuthorizedPropertyInfo = "tooltip-not-authorized"

type AttrGetType LockButtonTooltipNotAuthorizedPropertyInfo

type AttrGetType LockButtonTooltipNotAuthorizedPropertyInfo = Maybe Text

type AttrBaseTypeConstraint LockButtonTooltipNotAuthorizedPropertyInfo

type AttrBaseTypeConstraint LockButtonTooltipNotAuthorizedPropertyInfo = IsLockButton

type AttrSetTypeConstraint LockButtonTooltipNotAuthorizedPropertyInfo

type AttrSetTypeConstraint LockButtonTooltipNotAuthorizedPropertyInfo = * ~ Text

type AttrAllowedOps LockButtonTooltipNotAuthorizedPropertyInfo

type AttrAllowedOps LockButtonTooltipNotAuthorizedPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

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

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

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

lockButtonTooltipNotAuthorized :: AttrLabelProxy "tooltipNotAuthorized"

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

tooltipUnlock

data LockButtonTooltipUnlockPropertyInfo

Instances

AttrInfo LockButtonTooltipUnlockPropertyInfo

Associated Types

type AttrAllowedOps LockButtonTooltipUnlockPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint LockButtonTooltipUnlockPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint LockButtonTooltipUnlockPropertyInfo :: * -> Constraint

type AttrGetType LockButtonTooltipUnlockPropertyInfo :: *

type AttrLabel LockButtonTooltipUnlockPropertyInfo :: Symbol

type AttrOrigin LockButtonTooltipUnlockPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint LockButtonTooltipUnlockPropertyInfo o => Proxy * LockButtonTooltipUnlockPropertyInfo -> o -> IO (AttrGetType LockButtonTooltipUnlockPropertyInfo)

attrSet :: (AttrBaseTypeConstraint LockButtonTooltipUnlockPropertyInfo o, AttrSetTypeConstraint LockButtonTooltipUnlockPropertyInfo b) => Proxy * LockButtonTooltipUnlockPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint LockButtonTooltipUnlockPropertyInfo o => Proxy * LockButtonTooltipUnlockPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint LockButtonTooltipUnlockPropertyInfo o, AttrSetTypeConstraint LockButtonTooltipUnlockPropertyInfo b) => Proxy * LockButtonTooltipUnlockPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin LockButtonTooltipUnlockPropertyInfo

type AttrOrigin LockButtonTooltipUnlockPropertyInfo = LockButton

type AttrLabel LockButtonTooltipUnlockPropertyInfo

type AttrLabel LockButtonTooltipUnlockPropertyInfo = "tooltip-unlock"

type AttrGetType LockButtonTooltipUnlockPropertyInfo

type AttrGetType LockButtonTooltipUnlockPropertyInfo = Maybe Text

type AttrBaseTypeConstraint LockButtonTooltipUnlockPropertyInfo

type AttrBaseTypeConstraint LockButtonTooltipUnlockPropertyInfo = IsLockButton

type AttrSetTypeConstraint LockButtonTooltipUnlockPropertyInfo

type AttrSetTypeConstraint LockButtonTooltipUnlockPropertyInfo = * ~ Text

type AttrAllowedOps LockButtonTooltipUnlockPropertyInfo

type AttrAllowedOps LockButtonTooltipUnlockPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

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

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

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

lockButtonTooltipUnlock :: AttrLabelProxy "tooltipUnlock"

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