Gtk.PasswordEntry – gtk4 Reference Manual

PasswordEntry

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_password_entry_get_type ()" ) ]
public class PasswordEntry : Widget, Accessible, Buildable, ConstraintTarget, Editable

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

![An example GtkPasswordEntry](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 [[email protected]] 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_accessible_role_text_box role.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public bool activates_default { get; set; }
Whether to activate the default widget when Enter is pressed.
public MenuModel extra_menu { get; set; }
A menu model whose contents will be appended to the context menu.
public string placeholder_text { owned get; set; }
The text that will be displayed in the `GtkPasswordEntry` when it is empty and unfocused.
public bool show_peek_icon { get; set; }
Whether to show an icon for revealing the content.

Creation methods:

public PasswordEntry ()
Creates a `GtkPasswordEntry`.

Methods:

public unowned MenuModel? get_extra_menu ()
Gets the menu model set with set_extra_menu.
public bool get_show_peek_icon ()
Returns whether the entry is showing an icon to reveal the contents.
public void set_extra_menu (MenuModel? model)
Sets a menu model to add when constructing the context menu for this.
public void set_show_peek_icon (bool show_peek_icon)
Sets whether the entry should have a clickable icon to reveal the contents.

Signals:

public signal void activate ()
Emitted when the entry is activated.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable

All known members inherited from interface Gtk.Editable

2022 vala-language.org