PasswordEntryProtocol

public protocol PasswordEntryProtocol : EditableProtocol

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

An example GtkPasswordEntry

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 [ifaceGtk.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_ACCESSIBLE_ROLE_TEXT_BOX role.

The PasswordEntryProtocol protocol exposes the methods and properties of an underlying GtkPasswordEntry instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see PasswordEntry. Alternatively, use PasswordEntryRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkPasswordEntry instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • password_entry_ptr Default implementation

    Typed pointer to the underlying GtkPasswordEntry instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkPasswordEntry instance.

    Declaration

    Swift

    var password_entry_ptr: UnsafeMutablePointer<GtkPasswordEntry>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to PasswordEntryProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

PasswordEntry Class

  • Bind a PasswordEntryPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: PasswordEntryPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a PasswordEntry property

    Declaration

    Swift

    @inlinable
func get(property: PasswordEntryPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a PasswordEntry property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: PasswordEntryPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

PasswordEntry signals

  • Connect a Swift signal handler to the given, typed PasswordEntrySignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: PasswordEntrySignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    handler

    The Swift signal handler (function or callback) to invoke on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • Connect a C signal handler to the given, typed PasswordEntrySignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: PasswordEntrySignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    signalHandler

    The C function to be called on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub
  • onActivate(flags:handler:) Extension method

    Emitted when the entry is activated.

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

    Note

    This represents the underlying activate signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onActivate(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: PasswordEntryRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the activate signal is emitted
    Show on GitHub
  • activateSignal Extension method

    Typed activate signal for using the connect(signal:) methods

    Declaration

    Swift

    static var activateSignal: PasswordEntrySignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::activates-default signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyActivatesDefault(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: PasswordEntryRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyActivatesDefault signal is emitted
    Show on GitHub
  • notifyActivatesDefaultSignal Extension method

    Typed notify::activates-default signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyActivatesDefaultSignal: PasswordEntrySignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::extra-menu signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyExtraMenu(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: PasswordEntryRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyExtraMenu signal is emitted
    Show on GitHub
  • notifyExtraMenuSignal Extension method

    Typed notify::extra-menu signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyExtraMenuSignal: PasswordEntrySignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::placeholder-text signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyPlaceholderText(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: PasswordEntryRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyPlaceholderText signal is emitted
    Show on GitHub
  • notifyPlaceholderTextSignal Extension method

    Typed notify::placeholder-text signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyPlaceholderTextSignal: PasswordEntrySignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::show-peek-icon signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyShowPeekIcon(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: PasswordEntryRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyShowPeekIcon signal is emitted
    Show on GitHub
  • notifyShowPeekIconSignal Extension method

    Typed notify::show-peek-icon signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyShowPeekIconSignal: PasswordEntrySignalName { get }
    Show on GitHub

PasswordEntry Class: PasswordEntryProtocol extension (methods and fields)

  • getExtraMenu() Extension method

    Gets the menu model set with gtk_password_entry_set_extra_menu().

    Declaration

    Swift

    @inlinable
func getExtraMenu() -> GIO.MenuModelRef!
    Show on GitHub
  • getShowPeekIcon() Extension method

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

    Declaration

    Swift

    @inlinable
func getShowPeekIcon() -> Bool
    Show on GitHub
  • setExtraMenu(model:) Extension method

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

    Declaration

    Swift

    @inlinable
func setExtraMenu(model: GIO.MenuModelRef? = nil)
    Show on GitHub
  • setExtraMenu(model:) Extension method

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

    Declaration

    Swift

    @inlinable
func setExtraMenu<MenuModelT>(model: MenuModelT?) where MenuModelT : MenuModelProtocol
    Show on GitHub
  • set(showPeekIcon:) Extension method

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

    Setting this to false also hides the text again.

    Declaration

    Swift

    @inlinable
func set(showPeekIcon: Bool)
    Show on GitHub
  • extraMenu Extension method

    Gets the menu model set with gtk_password_entry_set_extra_menu().

    Declaration

    Swift

    @inlinable
var extraMenu: GIO.MenuModelRef! { get nonmutating set }
    Show on GitHub
  • showPeekIcon Extension method

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

    Declaration

    Swift

    @inlinable
var showPeekIcon: Bool { get nonmutating set }
    Show on GitHub