GtkPasswordEntry

GtkPasswordEntry — An entry for secrets

Properties

gboolean activates-default Read / Write
GMenuModel * extra-menu Read / Write
char * placeholder-text Read / Write
gboolean show-peek-icon Read / Write

Signals

void activate Action

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkPasswordEntry

Implemented Interfaces

GtkPasswordEntry implements GtkAccessible, GtkBuildable, GtkConstraintTarget and GtkEditable.

Includes

#include <gtk/gtk.h>

Description

GtkPasswordEntry 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. 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 GtkEditable 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.

Functions

gtk_password_entry_new ()

GtkWidget *
gtk_password_entry_new (void);

Creates a GtkPasswordEntry.

Returns

a new GtkPasswordEntry

gtk_password_entry_set_show_peek_icon ()

void
gtk_password_entry_set_show_peek_icon (GtkPasswordEntry *entry,
                                       gboolean show_peek_icon);

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.

Parameters

entry

a GtkPasswordEntry

show_peek_icon

whether to show the peek icon

gtk_password_entry_get_show_peek_icon ()

gboolean
gtk_password_entry_get_show_peek_icon (GtkPasswordEntry *entry);

Returns whether the entry is showing a clickable icon to reveal the contents of the entry in clear text.

Parameters

Returns

TRUE if an icon is shown

gtk_password_entry_set_extra_menu ()

void
gtk_password_entry_set_extra_menu (GtkPasswordEntry *entry,
                                   GMenuModel *model);

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

Parameters

entry

a GtkPasswordEntry

model

a GMenuModel.

[allow-none]

gtk_password_entry_get_extra_menu ()

GMenuModel *
gtk_password_entry_get_extra_menu (GtkPasswordEntry *entry);

Gets the menu model set with gtk_password_entry_set_extra_menu().

Parameters

entry

a GtkText

Returns

(nullable): the menu model.

[transfer none]

Types and Values

GtkPasswordEntry

typedef struct _GtkPasswordEntry GtkPasswordEntry;

Property Details

The “activates-default” property

  “activates-default”        gboolean

Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed.

Owner: GtkPasswordEntry

Flags: Read / Write

Default value: FALSE

The “extra-menu” property

  “extra-menu”               GMenuModel *

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

Owner: GtkPasswordEntry

Flags: Read / Write

The “placeholder-text” property

  “placeholder-text”         char *

Show text in the entry when it’s empty and unfocused.

Owner: GtkPasswordEntry

Flags: Read / Write

Default value: NULL

The “show-peek-icon” property

  “show-peek-icon”           gboolean

Whether to show an icon for revealing the content.

Owner: GtkPasswordEntry

Flags: Read / Write

Default value: FALSE

Signal Details

The “activate” signal

void
user_function (GtkPasswordEntry *passwordentry,
               gpointer          user_data)

Flags: Action

© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk4/4.0/GtkPasswordEntry.html