PasswordEntry#

class PasswordEntry(**properties: Any)#

Superclasses: Widget, InitiallyUnowned, Object

Implemented Interfaces: Accessible, Buildable, ConstraintTarget, Editable

GtkPasswordEntry is an entry that has been tailored for entering secrets.

https://docs.gtk.org/gtk4/password-entry.png

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. If the underlying platform allows it, GtkPasswordEntry will also place the text in a non-pageable memory area, to avoid it being written out to disk by the operating system.

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.

CSS Nodes#

entry.password
╰── text
    ├── image.caps-lock-indicator
    ┊

GtkPasswordEntry has a single CSS node with name entry that carries a .passwordstyle class. The text Css node below it has a child with name image and style class .caps-lock-indicator for the Caps Lock icon, and possibly other children.

Accessibility#

GtkPasswordEntry uses the TEXT_BOX role.

Constructors#

class PasswordEntry

classmethod new() → Widget#: Creates a GtkPasswordEntry.

Methods#

class PasswordEntry

get_extra_menu() → MenuModel | None#: Gets the menu model set with set_extra_menu().

get_show_peek_icon() → bool#: Returns whether the entry is showing an icon to reveal the contents.

set_extra_menu(model: MenuModel | None = None) → None#

Sets a menu model to add when constructing the context menu for entry.

Parameters:: model – a GMenuModel

set_show_peek_icon(show_peek_icon: bool) → None#

Sets whether the entry should have a clickable icon to reveal the contents.

Setting this to False also hides the text again.

Parameters:: show_peek_icon – whether to show the peek icon

Properties#

class PasswordEntry

props.activates_default: bool#: The type of the None singleton.

props.extra_menu: MenuModel#: The type of the None singleton.

props.placeholder_text: str#: The type of the None singleton.

props.show_peek_icon: bool#: The type of the None singleton.

Signals#

class PasswordEntry.signals

activate() → None#

Emitted when the entry is activated.

The keybindings for this signal are all forms of the Enter key.