Gtk.PasswordEntry¶

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 [iface`Gtk`.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 Gtk.AccessibleRole.TEXT_BOX role.

classmethod new()[source]¶

Returns:: a new GtkPasswordEntry
Return type:: Gtk.Widget

Creates a GtkPasswordEntry.

get_extra_menu()[source]¶

Returns:: the menu model
Return type:: Gio.MenuModel or None

Gets the menu model set with Gtk.PasswordEntry.set_extra_menu().

get_show_peek_icon()[source]¶

Returns:: True if an icon is shown
Return type:: bool

Returns whether the entry is showing an icon to reveal the contents.

set_extra_menu(model)[source]¶

Parameters:: model (Gio.MenuModel or None) – a GMenuModel

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

set_show_peek_icon(show_peek_icon)[source]¶

Parameters:: show_peek_icon (bool) – whether to show the peek icon

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

Setting this to False also hides the text again.

Signal Details¶

Gtk.PasswordEntry.signals.activate(password_entry)¶

Signal Name:: activate
Flags:: RUN_LAST, ACTION
Parameters:: password_entry (Gtk.PasswordEntry) – The object which received the signal

Emitted when the entry is activated.

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

Property Details¶

Gtk.PasswordEntry.props.activates_default¶

Name:: activates-default
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether to activate the default widget when Enter is pressed.

Gtk.PasswordEntry.props.extra_menu¶

Name:: extra-menu
Type:: Gio.MenuModel
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

A menu model whose contents will be appended to the context menu.

Gtk.PasswordEntry.props.placeholder_text¶

Name:: placeholder-text
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The text that will be displayed in the GtkPasswordEntry when it is empty and unfocused.

Gtk.PasswordEntry.props.show_peek_icon¶

Name:: show-peek-icon
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether to show an icon for revealing the content.