gi-gio
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

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

Exported types

newtype TlsPassword Source #

Memory-managed wrapper type.

Instances

Instances details
Eq TlsPassword Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

GObject TlsPassword Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

ManagedPtrNewtype TlsPassword Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

TypedObject TlsPassword Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

Methods

glibType :: IO GType #

HasParentTypes TlsPassword Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

HasAttributeList TlsPassword Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

(info ~ ResolveTlsPasswordMethod t TlsPassword, OverloadedMethod info TlsPassword p, HasField t TlsPassword p) => HasField (t :: Symbol) TlsPassword (p :: Type) Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

Methods

getField :: TlsPassword -> p #

(info ~ ResolveTlsPasswordMethod t TlsPassword, OverloadedMethodInfo info TlsPassword) => IsLabel t (MethodProxy info TlsPassword) Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

(info ~ ResolveTlsPasswordMethod t TlsPassword, OverloadedMethod info TlsPassword p) => IsLabel t (TlsPassword -> p) Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

Methods

fromLabel :: TlsPassword -> p #

IsGValue (Maybe TlsPassword) Source #

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

Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttributeList TlsPassword Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type ParentTypes TlsPassword Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type SignalList TlsPassword Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

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

Instances details
(GObject o, IsDescendantOf TlsPassword o) => IsTlsPassword o Source # 
Instance details

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

type family ResolveTlsPasswordMethod (t :: Symbol) o where ... Source #

Equations

ResolveTlsPasswordMethod "bindProperty" o = ObjectBindPropertyMethodInfo 
ResolveTlsPasswordMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo 
ResolveTlsPasswordMethod "forceFloating" o = ObjectForceFloatingMethodInfo 
ResolveTlsPasswordMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo 
ResolveTlsPasswordMethod "getv" o = ObjectGetvMethodInfo 
ResolveTlsPasswordMethod "isFloating" o = ObjectIsFloatingMethodInfo 
ResolveTlsPasswordMethod "notify" o = ObjectNotifyMethodInfo 
ResolveTlsPasswordMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo 
ResolveTlsPasswordMethod "ref" o = ObjectRefMethodInfo 
ResolveTlsPasswordMethod "refSink" o = ObjectRefSinkMethodInfo 
ResolveTlsPasswordMethod "runDispose" o = ObjectRunDisposeMethodInfo 
ResolveTlsPasswordMethod "stealData" o = ObjectStealDataMethodInfo 
ResolveTlsPasswordMethod "stealQdata" o = ObjectStealQdataMethodInfo 
ResolveTlsPasswordMethod "thawNotify" o = ObjectThawNotifyMethodInfo 
ResolveTlsPasswordMethod "unref" o = ObjectUnrefMethodInfo 
ResolveTlsPasswordMethod "watchClosure" o = ObjectWatchClosureMethodInfo 
ResolveTlsPasswordMethod "getData" o = ObjectGetDataMethodInfo 
ResolveTlsPasswordMethod "getDescription" o = TlsPasswordGetDescriptionMethodInfo 
ResolveTlsPasswordMethod "getFlags" o = TlsPasswordGetFlagsMethodInfo 
ResolveTlsPasswordMethod "getProperty" o = ObjectGetPropertyMethodInfo 
ResolveTlsPasswordMethod "getQdata" o = ObjectGetQdataMethodInfo 
ResolveTlsPasswordMethod "getWarning" o = TlsPasswordGetWarningMethodInfo 
ResolveTlsPasswordMethod "setData" o = ObjectSetDataMethodInfo 
ResolveTlsPasswordMethod "setDataFull" o = ObjectSetDataFullMethodInfo 
ResolveTlsPasswordMethod "setDescription" o = TlsPasswordSetDescriptionMethodInfo 
ResolveTlsPasswordMethod "setFlags" o = TlsPasswordSetFlagsMethodInfo 
ResolveTlsPasswordMethod "setProperty" o = ObjectSetPropertyMethodInfo 
ResolveTlsPasswordMethod "setValue" o = TlsPasswordSetValueMethodInfo 
ResolveTlsPasswordMethod "setValueFull" o = TlsPasswordSetValueFullMethodInfo 
ResolveTlsPasswordMethod "setWarning" o = TlsPasswordSetWarningMethodInfo 
ResolveTlsPasswordMethod l o = MethodResolutionFailed l o :: Type 

getDescription

tlsPasswordGetDescription Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a) 
=> a

password: a TlsPassword object

-> m Text

Returns: The description of the password.

Get a description string about what the password will be used for.

Since: 2.30

getFlags

tlsPasswordGetFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a) 
=> a

password: a TlsPassword object

-> m [TlsPasswordFlags]

Returns: The flags about the password.

Get flags about the password.

Since: 2.30

getWarning

tlsPasswordGetWarning Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a) 
=> a

password: a TlsPassword object

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

tlsPasswordNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> [TlsPasswordFlags]

flags: the password flags

-> Text

description: description of what the password is for

-> m TlsPassword

Returns: The newly allocated password object

Create a new TlsPassword object.

setDescription

tlsPasswordSetDescription Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a) 
=> a

password: a TlsPassword object

-> Text

description: The description of the password

-> m () 

Set a description string about what the password will be used for.

Since: 2.30

setFlags

tlsPasswordSetFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a) 
=> a

password: a TlsPassword object

-> [TlsPasswordFlags]

flags: The flags about the password

-> m () 

Set flags about the password.

Since: 2.30

setValue

data TlsPasswordSetValueMethodInfo Source #

Instances

Instances details
(signature ~ (ByteString -> m ()), MonadIO m, IsTlsPassword a) => OverloadedMethod TlsPasswordSetValueMethodInfo a signature Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo TlsPasswordSetValueMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

tlsPasswordSetValue Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a) 
=> a

password: a TlsPassword object

-> ByteString

value: the new password value

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

tlsPasswordSetValueFull Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a) 
=> a

password: a TlsPassword object

-> ByteString

value: the value for the password

-> Maybe DestroyNotify

destroy: a function to use to free the password.

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

Instances details
(signature ~ (Text -> m ()), MonadIO m, IsTlsPassword a) => OverloadedMethod TlsPasswordSetWarningMethodInfo a signature Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo TlsPasswordSetWarningMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

tlsPasswordSetWarning Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a) 
=> a

password: a TlsPassword object

-> Text

warning: The user readable warning

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

Instances details
AttrInfo TlsPasswordDescriptionPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

Associated Types

type AttrAllowedOps TlsPasswordDescriptionPropertyInfo 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrBaseTypeConstraint TlsPasswordDescriptionPropertyInfo 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrGetType TlsPasswordDescriptionPropertyInfo 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrSetTypeConstraint TlsPasswordDescriptionPropertyInfo 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrTransferTypeConstraint TlsPasswordDescriptionPropertyInfo 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrTransferType TlsPasswordDescriptionPropertyInfo 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrLabel TlsPasswordDescriptionPropertyInfo 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrOrigin TlsPasswordDescriptionPropertyInfo 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrAllowedOps TlsPasswordDescriptionPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrBaseTypeConstraint TlsPasswordDescriptionPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrGetType TlsPasswordDescriptionPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrLabel TlsPasswordDescriptionPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrOrigin TlsPasswordDescriptionPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrSetTypeConstraint TlsPasswordDescriptionPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrTransferType TlsPasswordDescriptionPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrTransferTypeConstraint TlsPasswordDescriptionPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

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

set tlsPassword [ #description := value ]

flags

Flags about the password.

Since: 2.30

data TlsPasswordFlagsPropertyInfo Source #

Instances

Instances details
AttrInfo TlsPasswordFlagsPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrAllowedOps TlsPasswordFlagsPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrBaseTypeConstraint TlsPasswordFlagsPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrGetType TlsPasswordFlagsPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrLabel TlsPasswordFlagsPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrOrigin TlsPasswordFlagsPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrSetTypeConstraint TlsPasswordFlagsPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrTransferType TlsPasswordFlagsPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrTransferTypeConstraint TlsPasswordFlagsPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

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

set tlsPassword [ #flags := value ]

warning

Warning about the password.

Since: 2.30

data TlsPasswordWarningPropertyInfo Source #

Instances

Instances details
AttrInfo TlsPasswordWarningPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrAllowedOps TlsPasswordWarningPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrBaseTypeConstraint TlsPasswordWarningPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrGetType TlsPasswordWarningPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrLabel TlsPasswordWarningPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrOrigin TlsPasswordWarningPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrSetTypeConstraint TlsPasswordWarningPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrTransferType TlsPasswordWarningPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.TlsPassword

type AttrTransferTypeConstraint TlsPasswordWarningPropertyInfo Source # 
Instance details

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

set tlsPassword [ #warning := value ]