Struct gtk4::PasswordEntry

#[repr(transparent)]
pub struct PasswordEntry { /* private fields */ }

PasswordEntry is an 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, PasswordEntry 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.

PasswordEntry provides only minimal API and should be used with the Editable API.

CSS Nodes

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

PasswordEntry 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

PasswordEntry uses the AccessibleRole::TextBox role.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, EditableExt, WidgetExtManual, AccessibleExtManual, EditableExtManual

Implementations

impl PasswordEntry

pub fn new() -> PasswordEntry

Creates a PasswordEntry.

Returns

a new PasswordEntry

pub fn builder() -> PasswordEntryBuilder

Creates a new builder-pattern struct instance to construct PasswordEntry objects.

This method returns an instance of PasswordEntryBuilder which can be used to create PasswordEntry objects.

pub fn extra_menu(&self) -> Option<MenuModel>

Gets the menu model set with gtk_password_entry_set_extra_menu().

Returns

the menu model

pub fn shows_peek_icon(&self) -> bool

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

Returns

true if an icon is shown

pub fn set_extra_menu(&self, model: Option<&impl IsA<MenuModel>>)

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

model

a GMenuModel

pub fn set_show_peek_icon(&self, show_peek_icon: bool)

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

Setting this to false also hides the text again.

show_peek_icon

whether to show the peek icon

pub fn activates_default(&self) -> bool

Whether to activate the default widget when Enter is pressed.

pub fn set_activates_default(&self, activates_default: bool)

Whether to activate the default widget when Enter is pressed.

pub fn placeholder_text(&self) -> Option<GString>

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

pub fn set_placeholder_text(&self, placeholder_text: Option<&str>)

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

pub fn connect_activate<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted when the entry is activated.

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

pub fn emit_activate(&self)

pub fn connect_activates_default_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_extra_menu_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_placeholder_text_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_show_peek_icon_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Trait Implementations

impl Clone for PasswordEntry

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PasswordEntry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PasswordEntry

fn default() -> Self

Returns the “default value” for a type.

impl Display for PasswordEntry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for PasswordEntry

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PasswordEntry

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for PasswordEntry

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for PasswordEntry

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for PasswordEntry

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for PasswordEntry

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PasswordEntry

impl IsA<Accessible> for PasswordEntry

impl IsA<Buildable> for PasswordEntry

impl IsA<ConstraintTarget> for PasswordEntry

impl IsA<Editable> for PasswordEntry

impl IsA<Widget> for PasswordEntry