Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
PasswordEntry
is entry that has been tailored for entering secrets.
It does not show its contents in clear text, does not allow to copy it
to the clipboard, and it shows a warning when Caps Lock is engaged.
Optionally, it can offer a way to reveal the contents in clear text.
GtkPasswordEntry provides only minimal API and should be used with the
Editable
API.
Synopsis
- newtype PasswordEntry = PasswordEntry (ManagedPtr PasswordEntry)
- class (GObject o, IsDescendantOf PasswordEntry o) => IsPasswordEntry o
- toPasswordEntry :: (MonadIO m, IsPasswordEntry o) => o -> m PasswordEntry
- passwordEntryGetExtraMenu :: (HasCallStack, MonadIO m, IsPasswordEntry a) => a -> m MenuModel
- passwordEntryGetShowPeekIcon :: (HasCallStack, MonadIO m, IsPasswordEntry a) => a -> m Bool
- passwordEntryNew :: (HasCallStack, MonadIO m) => m PasswordEntry
- passwordEntrySetExtraMenu :: (HasCallStack, MonadIO m, IsPasswordEntry a, IsMenuModel b) => a -> Maybe b -> m ()
- passwordEntrySetShowPeekIcon :: (HasCallStack, MonadIO m, IsPasswordEntry a) => a -> Bool -> m ()
- constructPasswordEntryActivatesDefault :: (IsPasswordEntry o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPasswordEntryActivatesDefault :: (MonadIO m, IsPasswordEntry o) => o -> m Bool
- setPasswordEntryActivatesDefault :: (MonadIO m, IsPasswordEntry o) => o -> Bool -> m ()
- clearPasswordEntryExtraMenu :: (MonadIO m, IsPasswordEntry o) => o -> m ()
- constructPasswordEntryExtraMenu :: (IsPasswordEntry o, MonadIO m, IsMenuModel a) => a -> m (GValueConstruct o)
- getPasswordEntryExtraMenu :: (MonadIO m, IsPasswordEntry o) => o -> m MenuModel
- setPasswordEntryExtraMenu :: (MonadIO m, IsPasswordEntry o, IsMenuModel a) => o -> a -> m ()
- clearPasswordEntryPlaceholderText :: (MonadIO m, IsPasswordEntry o) => o -> m ()
- constructPasswordEntryPlaceholderText :: (IsPasswordEntry o, MonadIO m) => Text -> m (GValueConstruct o)
- getPasswordEntryPlaceholderText :: (MonadIO m, IsPasswordEntry o) => o -> m (Maybe Text)
- setPasswordEntryPlaceholderText :: (MonadIO m, IsPasswordEntry o) => o -> Text -> m ()
- constructPasswordEntryShowPeekIcon :: (IsPasswordEntry o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPasswordEntryShowPeekIcon :: (MonadIO m, IsPasswordEntry o) => o -> m Bool
- setPasswordEntryShowPeekIcon :: (MonadIO m, IsPasswordEntry o) => o -> Bool -> m ()
Exported types
newtype PasswordEntry Source #
Memory-managed wrapper type.
Instances
Eq PasswordEntry Source # | |
Defined in GI.Gtk.Objects.PasswordEntry (==) :: PasswordEntry -> PasswordEntry -> Bool # (/=) :: PasswordEntry -> PasswordEntry -> Bool # | |
IsGValue PasswordEntry Source # | Convert |
Defined in GI.Gtk.Objects.PasswordEntry toGValue :: PasswordEntry -> IO GValue # fromGValue :: GValue -> IO PasswordEntry # | |
ManagedPtrNewtype PasswordEntry Source # | |
Defined in GI.Gtk.Objects.PasswordEntry | |
TypedObject PasswordEntry Source # | |
Defined in GI.Gtk.Objects.PasswordEntry | |
GObject PasswordEntry Source # | |
Defined in GI.Gtk.Objects.PasswordEntry | |
HasParentTypes PasswordEntry Source # | |
Defined in GI.Gtk.Objects.PasswordEntry | |
type ParentTypes PasswordEntry Source # | |
Defined in GI.Gtk.Objects.PasswordEntry type ParentTypes PasswordEntry = '[Widget, Object, ImplementorIface, Buildable, ConstraintTarget, Editable] |
class (GObject o, IsDescendantOf PasswordEntry o) => IsPasswordEntry o Source #
Type class for types which can be safely cast to PasswordEntry
, for instance with toPasswordEntry
.
Instances
(GObject o, IsDescendantOf PasswordEntry o) => IsPasswordEntry o Source # | |
Defined in GI.Gtk.Objects.PasswordEntry |
toPasswordEntry :: (MonadIO m, IsPasswordEntry o) => o -> m PasswordEntry Source #
Cast to PasswordEntry
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Overloaded methods
getExtraMenu
passwordEntryGetExtraMenu Source #
:: (HasCallStack, MonadIO m, IsPasswordEntry a) | |
=> a |
|
-> m MenuModel | Returns: (nullable): the menu model |
Gets the menu model set with passwordEntrySetExtraMenu
.
getShowPeekIcon
passwordEntryGetShowPeekIcon Source #
:: (HasCallStack, MonadIO m, IsPasswordEntry a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the entry is showing a clickable icon to reveal the contents of the entry in clear text.
new
:: (HasCallStack, MonadIO m) | |
=> m PasswordEntry | Returns: a new |
Creates a PasswordEntry
.
setExtraMenu
passwordEntrySetExtraMenu Source #
:: (HasCallStack, MonadIO m, IsPasswordEntry a, IsMenuModel b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets a menu model to add when constructing
the context menu for entry
.
setShowPeekIcon
passwordEntrySetShowPeekIcon Source #
:: (HasCallStack, MonadIO m, IsPasswordEntry a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the entry should have a clickable icon to show the contents of the entry in clear text.
Setting this to False
also hides the text again.
Properties
activatesDefault
No description available in the introspection data.
constructPasswordEntryActivatesDefault :: (IsPasswordEntry o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “activates-default
” property. This is rarely needed directly, but it is used by new
.
getPasswordEntryActivatesDefault :: (MonadIO m, IsPasswordEntry o) => o -> m Bool Source #
Get the value of the “activates-default
” property.
When overloading is enabled, this is equivalent to
get
passwordEntry #activatesDefault
setPasswordEntryActivatesDefault :: (MonadIO m, IsPasswordEntry o) => o -> Bool -> m () Source #
Set the value of the “activates-default
” property.
When overloading is enabled, this is equivalent to
set
passwordEntry [ #activatesDefault:=
value ]
extraMenu
A menu model whose contents will be appended to the context menu.
clearPasswordEntryExtraMenu :: (MonadIO m, IsPasswordEntry o) => o -> m () Source #
Set the value of the “extra-menu
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#extraMenu
constructPasswordEntryExtraMenu :: (IsPasswordEntry o, MonadIO m, IsMenuModel a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “extra-menu
” property. This is rarely needed directly, but it is used by new
.
getPasswordEntryExtraMenu :: (MonadIO m, IsPasswordEntry o) => o -> m MenuModel Source #
Get the value of the “extra-menu
” property.
When overloading is enabled, this is equivalent to
get
passwordEntry #extraMenu
setPasswordEntryExtraMenu :: (MonadIO m, IsPasswordEntry o, IsMenuModel a) => o -> a -> m () Source #
Set the value of the “extra-menu
” property.
When overloading is enabled, this is equivalent to
set
passwordEntry [ #extraMenu:=
value ]
placeholderText
No description available in the introspection data.
clearPasswordEntryPlaceholderText :: (MonadIO m, IsPasswordEntry o) => o -> m () Source #
Set the value of the “placeholder-text
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#placeholderText
constructPasswordEntryPlaceholderText :: (IsPasswordEntry o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “placeholder-text
” property. This is rarely needed directly, but it is used by new
.
getPasswordEntryPlaceholderText :: (MonadIO m, IsPasswordEntry o) => o -> m (Maybe Text) Source #
Get the value of the “placeholder-text
” property.
When overloading is enabled, this is equivalent to
get
passwordEntry #placeholderText
setPasswordEntryPlaceholderText :: (MonadIO m, IsPasswordEntry o) => o -> Text -> m () Source #
Set the value of the “placeholder-text
” property.
When overloading is enabled, this is equivalent to
set
passwordEntry [ #placeholderText:=
value ]
showPeekIcon
No description available in the introspection data.
constructPasswordEntryShowPeekIcon :: (IsPasswordEntry o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “show-peek-icon
” property. This is rarely needed directly, but it is used by new
.
getPasswordEntryShowPeekIcon :: (MonadIO m, IsPasswordEntry o) => o -> m Bool Source #
Get the value of the “show-peek-icon
” property.
When overloading is enabled, this is equivalent to
get
passwordEntry #showPeekIcon
setPasswordEntryShowPeekIcon :: (MonadIO m, IsPasswordEntry o) => o -> Bool -> m () Source #
Set the value of the “show-peek-icon
” property.
When overloading is enabled, this is equivalent to
set
passwordEntry [ #showPeekIcon:=
value ]