| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gio.Objects.TlsPassword
Description
An abstract interface representing a password used in TLS. Often used in user interaction such as unlocking a key storage token.
Since: 2.30
Synopsis
- newtype TlsPassword = TlsPassword (ManagedPtr TlsPassword)
- class (GObject o, IsDescendantOf TlsPassword o) => IsTlsPassword o
- toTlsPassword :: (MonadIO m, IsTlsPassword o) => o -> m TlsPassword
- type family ResolveTlsPasswordMethod (t :: Symbol) o where ...
- data TlsPasswordGetDescriptionMethodInfo
- tlsPasswordGetDescription :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> m Text
- data TlsPasswordGetFlagsMethodInfo
- tlsPasswordGetFlags :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> m [TlsPasswordFlags]
- data TlsPasswordGetWarningMethodInfo
- tlsPasswordGetWarning :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> m Text
- tlsPasswordNew :: (HasCallStack, MonadIO m) => [TlsPasswordFlags] -> Text -> m TlsPassword
- data TlsPasswordSetDescriptionMethodInfo
- tlsPasswordSetDescription :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> Text -> m ()
- data TlsPasswordSetFlagsMethodInfo
- tlsPasswordSetFlags :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> [TlsPasswordFlags] -> m ()
- data TlsPasswordSetValueMethodInfo
- tlsPasswordSetValue :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> ByteString -> m ()
- data TlsPasswordSetValueFullMethodInfo
- tlsPasswordSetValueFull :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> ByteString -> Maybe DestroyNotify -> m ()
- data TlsPasswordSetWarningMethodInfo
- tlsPasswordSetWarning :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> Text -> m ()
- data TlsPasswordDescriptionPropertyInfo
- constructTlsPasswordDescription :: (IsTlsPassword o, MonadIO m) => Text -> m (GValueConstruct o)
- getTlsPasswordDescription :: (MonadIO m, IsTlsPassword o) => o -> m Text
- setTlsPasswordDescription :: (MonadIO m, IsTlsPassword o) => o -> Text -> m ()
- tlsPasswordDescription :: AttrLabelProxy "description"
- data TlsPasswordFlagsPropertyInfo
- constructTlsPasswordFlags :: (IsTlsPassword o, MonadIO m) => [TlsPasswordFlags] -> m (GValueConstruct o)
- getTlsPasswordFlags :: (MonadIO m, IsTlsPassword o) => o -> m [TlsPasswordFlags]
- setTlsPasswordFlags :: (MonadIO m, IsTlsPassword o) => o -> [TlsPasswordFlags] -> m ()
- tlsPasswordFlags :: AttrLabelProxy "flags"
- data TlsPasswordWarningPropertyInfo
- constructTlsPasswordWarning :: (IsTlsPassword o, MonadIO m) => Text -> m (GValueConstruct o)
- getTlsPasswordWarning :: (MonadIO m, IsTlsPassword o) => o -> m Text
- setTlsPasswordWarning :: (MonadIO m, IsTlsPassword o) => o -> Text -> m ()
- tlsPasswordWarning :: AttrLabelProxy "warning"
Exported types
newtype TlsPassword Source #
Memory-managed wrapper type.
Constructors
| TlsPassword (ManagedPtr TlsPassword) |
Instances
class (GObject o, IsDescendantOf TlsPassword o) => IsTlsPassword o Source #
Type class for types which can be safely cast to TlsPassword, for instance with toTlsPassword.
Instances
| (GObject o, IsDescendantOf TlsPassword o) => IsTlsPassword o Source # | |
Defined in GI.Gio.Objects.TlsPassword | |
toTlsPassword :: (MonadIO m, IsTlsPassword o) => o -> m TlsPassword Source #
Cast to TlsPassword, 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
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getDescription, getFlags, getProperty, getQdata, getWarning.
Setters
setData, setDataFull, setDescription, setFlags, setProperty, setValue, setValueFull, setWarning.
type family ResolveTlsPasswordMethod (t :: Symbol) o where ... Source #
Equations
getDescription
data TlsPasswordGetDescriptionMethodInfo Source #
Instances
| (signature ~ m Text, MonadIO m, IsTlsPassword a) => OverloadedMethod TlsPasswordGetDescriptionMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo TlsPasswordGetDescriptionMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods | |
tlsPasswordGetDescription Source #
Arguments
| :: (HasCallStack, MonadIO m, IsTlsPassword a) | |
| => a |
|
| -> m Text | Returns: The description of the password. |
Get a description string about what the password will be used for.
Since: 2.30
getFlags
data TlsPasswordGetFlagsMethodInfo Source #
Instances
| (signature ~ m [TlsPasswordFlags], MonadIO m, IsTlsPassword a) => OverloadedMethod TlsPasswordGetFlagsMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo TlsPasswordGetFlagsMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsTlsPassword a) | |
| => a |
|
| -> m [TlsPasswordFlags] | Returns: The flags about the password. |
Get flags about the password.
Since: 2.30
getWarning
data TlsPasswordGetWarningMethodInfo Source #
Instances
| (signature ~ m Text, MonadIO m, IsTlsPassword a) => OverloadedMethod TlsPasswordGetWarningMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo TlsPasswordGetWarningMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods | |
tlsPasswordGetWarning Source #
Arguments
| :: (HasCallStack, MonadIO m, IsTlsPassword a) | |
| => a |
|
| -> m Text | Returns: The warning. |
Get a user readable translated warning. Usually this warning is a
representation of the password flags returned from
tlsPasswordGetFlags.
Since: 2.30
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => [TlsPasswordFlags] |
|
| -> Text |
|
| -> m TlsPassword | Returns: The newly allocated password object |
Create a new TlsPassword object.
setDescription
data TlsPasswordSetDescriptionMethodInfo Source #
Instances
| (signature ~ (Text -> m ()), MonadIO m, IsTlsPassword a) => OverloadedMethod TlsPasswordSetDescriptionMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo TlsPasswordSetDescriptionMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods | |
tlsPasswordSetDescription Source #
Arguments
| :: (HasCallStack, MonadIO m, IsTlsPassword a) | |
| => a |
|
| -> Text |
|
| -> m () |
Set a description string about what the password will be used for.
Since: 2.30
setFlags
data TlsPasswordSetFlagsMethodInfo Source #
Instances
| (signature ~ ([TlsPasswordFlags] -> m ()), MonadIO m, IsTlsPassword a) => OverloadedMethod TlsPasswordSetFlagsMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo TlsPasswordSetFlagsMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsTlsPassword a) | |
| => a |
|
| -> [TlsPasswordFlags] |
|
| -> m () |
Set flags about the password.
Since: 2.30
setValue
data TlsPasswordSetValueMethodInfo Source #
Instances
| (signature ~ (ByteString -> m ()), MonadIO m, IsTlsPassword a) => OverloadedMethod TlsPasswordSetValueMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo TlsPasswordSetValueMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsTlsPassword a) | |
| => a |
|
| -> ByteString |
|
| -> m () |
Set the value for this password. The value will be copied by the password
object.
Specify the length, for a non-nul-terminated password. Pass -1 as
length if using a nul-terminated password, and length will be
calculated automatically. (Note that the terminating nul is not
considered part of the password in this case.)
Since: 2.30
setValueFull
data TlsPasswordSetValueFullMethodInfo Source #
Instances
| (signature ~ (ByteString -> Maybe DestroyNotify -> m ()), MonadIO m, IsTlsPassword a) => OverloadedMethod TlsPasswordSetValueFullMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo TlsPasswordSetValueFullMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods | |
tlsPasswordSetValueFull Source #
Arguments
| :: (HasCallStack, MonadIO m, IsTlsPassword a) | |
| => a |
|
| -> ByteString |
|
| -> Maybe DestroyNotify |
|
| -> m () |
Provide the value for this password.
The value will be owned by the password object, and later freed using
the destroy function callback.
Specify the length, for a non-nul-terminated password. Pass -1 as
length if using a nul-terminated password, and length will be
calculated automatically. (Note that the terminating nul is not
considered part of the password in this case.)
Since: 2.30
setWarning
data TlsPasswordSetWarningMethodInfo Source #
Instances
| (signature ~ (Text -> m ()), MonadIO m, IsTlsPassword a) => OverloadedMethod TlsPasswordSetWarningMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo TlsPasswordSetWarningMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.TlsPassword Methods | |
tlsPasswordSetWarning Source #
Arguments
| :: (HasCallStack, MonadIO m, IsTlsPassword a) | |
| => a |
|
| -> Text |
|
| -> m () |
Set a user readable translated warning. Usually this warning is a
representation of the password flags returned from
tlsPasswordGetFlags.
Since: 2.30
Properties
description
Description of what the password is for.
Since: 2.30
data TlsPasswordDescriptionPropertyInfo Source #
Instances
constructTlsPasswordDescription :: (IsTlsPassword o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “description” property. This is rarely needed directly, but it is used by new.
getTlsPasswordDescription :: (MonadIO m, IsTlsPassword o) => o -> m Text Source #
Get the value of the “description” property.
When overloading is enabled, this is equivalent to
get tlsPassword #description
setTlsPasswordDescription :: (MonadIO m, IsTlsPassword o) => o -> Text -> m () Source #
Set the value of the “description” property.
When overloading is enabled, this is equivalent to
settlsPassword [ #description:=value ]
tlsPasswordDescription :: AttrLabelProxy "description" Source #
flags
Flags about the password.
Since: 2.30
data TlsPasswordFlagsPropertyInfo Source #
Instances
| AttrInfo TlsPasswordFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword Associated Types
Methods attrGet :: AttrBaseTypeConstraint TlsPasswordFlagsPropertyInfo o => o -> IO (AttrGetType TlsPasswordFlagsPropertyInfo) # attrSet :: (AttrBaseTypeConstraint TlsPasswordFlagsPropertyInfo o, AttrSetTypeConstraint TlsPasswordFlagsPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint TlsPasswordFlagsPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint TlsPasswordFlagsPropertyInfo o, AttrSetTypeConstraint TlsPasswordFlagsPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint TlsPasswordFlagsPropertyInfo o, AttrTransferTypeConstraint TlsPasswordFlagsPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType TlsPasswordFlagsPropertyInfo) # | |||||||||||||||||||||||||||||||||
| type AttrAllowedOps TlsPasswordFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword | |||||||||||||||||||||||||||||||||
| type AttrBaseTypeConstraint TlsPasswordFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrGetType TlsPasswordFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword | |||||||||||||||||||||||||||||||||
| type AttrLabel TlsPasswordFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword | |||||||||||||||||||||||||||||||||
| type AttrOrigin TlsPasswordFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword | |||||||||||||||||||||||||||||||||
| type AttrSetTypeConstraint TlsPasswordFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword | |||||||||||||||||||||||||||||||||
| type AttrTransferType TlsPasswordFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword | |||||||||||||||||||||||||||||||||
| type AttrTransferTypeConstraint TlsPasswordFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
constructTlsPasswordFlags :: (IsTlsPassword o, MonadIO m) => [TlsPasswordFlags] -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “flags” property. This is rarely needed directly, but it is used by new.
getTlsPasswordFlags :: (MonadIO m, IsTlsPassword o) => o -> m [TlsPasswordFlags] Source #
Get the value of the “flags” property.
When overloading is enabled, this is equivalent to
get tlsPassword #flags
setTlsPasswordFlags :: (MonadIO m, IsTlsPassword o) => o -> [TlsPasswordFlags] -> m () Source #
Set the value of the “flags” property.
When overloading is enabled, this is equivalent to
settlsPassword [ #flags:=value ]
tlsPasswordFlags :: AttrLabelProxy "flags" Source #
warning
Warning about the password.
Since: 2.30
data TlsPasswordWarningPropertyInfo Source #
Instances
| AttrInfo TlsPasswordWarningPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword Associated Types
Methods attrGet :: AttrBaseTypeConstraint TlsPasswordWarningPropertyInfo o => o -> IO (AttrGetType TlsPasswordWarningPropertyInfo) # attrSet :: (AttrBaseTypeConstraint TlsPasswordWarningPropertyInfo o, AttrSetTypeConstraint TlsPasswordWarningPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint TlsPasswordWarningPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint TlsPasswordWarningPropertyInfo o, AttrSetTypeConstraint TlsPasswordWarningPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint TlsPasswordWarningPropertyInfo o, AttrTransferTypeConstraint TlsPasswordWarningPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType TlsPasswordWarningPropertyInfo) # | |||||||||||||||||||||||||||||||||
| type AttrAllowedOps TlsPasswordWarningPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword | |||||||||||||||||||||||||||||||||
| type AttrBaseTypeConstraint TlsPasswordWarningPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrGetType TlsPasswordWarningPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword | |||||||||||||||||||||||||||||||||
| type AttrLabel TlsPasswordWarningPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword | |||||||||||||||||||||||||||||||||
| type AttrOrigin TlsPasswordWarningPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword | |||||||||||||||||||||||||||||||||
| type AttrSetTypeConstraint TlsPasswordWarningPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword | |||||||||||||||||||||||||||||||||
| type AttrTransferType TlsPasswordWarningPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword | |||||||||||||||||||||||||||||||||
| type AttrTransferTypeConstraint TlsPasswordWarningPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.TlsPassword | |||||||||||||||||||||||||||||||||
constructTlsPasswordWarning :: (IsTlsPassword o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “warning” property. This is rarely needed directly, but it is used by new.
getTlsPasswordWarning :: (MonadIO m, IsTlsPassword o) => o -> m Text Source #
Get the value of the “warning” property.
When overloading is enabled, this is equivalent to
get tlsPassword #warning
setTlsPasswordWarning :: (MonadIO m, IsTlsPassword o) => o -> Text -> m () Source #
Set the value of the “warning” property.
When overloading is enabled, this is equivalent to
settlsPassword [ #warning:=value ]
tlsPasswordWarning :: AttrLabelProxy "warning" Source #