Package org.gnome.gtk

Class PasswordEntry

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.gtk.PasswordEntry

All Implemented Interfaces:

Proxy, Accessible, Buildable, ConstraintTarget, Editable

@Generated("io.github.jwharm.JavaGI")
public class PasswordEntry
extends Widget
implements Accessible, Buildable, ConstraintTarget, Editable

A single-line text entry widget for entering passwords and other secrets.

<picture> <source srcset="password-entry-dark.png" media="(prefers-color-scheme: dark)"> <img alt="An example GtkPasswordEntry" src="password-entry.png"> </picture>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PasswordEntry.ActivateCallback	Functional interface declaration of the ActivateCallback callback.
static class	PasswordEntry.Builder<B extends PasswordEntry.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	PasswordEntry.PasswordEntryClass

Nested classes/interfaces inherited from class org.gnome.gtk.Widget

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.WidgetClass, Widget.WidgetImpl

Nested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Accessible

Accessible.AccessibleImpl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.BuildableIface, Buildable.BuildableImpl

Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget

ConstraintTarget.ConstraintTargetImpl, ConstraintTarget.ConstraintTargetInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Editable

Editable.ChangedCallback, Editable.DeleteTextCallback, Editable.EditableImpl, Editable.EditableInterface, Editable.InsertTextCallback

Field Summary

Fields inherited from class io.github.jwharm.javagi.base.ProxyInstance

address

Constructor Summary

Constructors

Constructor	Description
PasswordEntry()	Creates a new PasswordEntry.
PasswordEntry(MemorySegment address)	Create a PasswordEntry proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected PasswordEntry	asParent()	Returns this instance as if it were its parent type.
static PasswordEntry.Builder<? extends PasswordEntry.Builder>	builder()	A PasswordEntry.Builder object constructs a PasswordEntry with the specified properties.
void	emitActivate()	Emits the "activate" signal.
MenuModel	getExtraMenu()	Gets the menu model set with gtk_password_entry_set_extra_menu().
boolean	getShowPeekIcon()	Returns whether the entry is showing an icon to reveal the contents.
static Type	getType()	Get the GType of the PasswordEntry class
SignalConnection<PasswordEntry.ActivateCallback>	onActivate(PasswordEntry.ActivateCallback handler)	Emitted when the entry is activated.
void	setExtraMenu(@Nullable MenuModel model)	Sets a menu model to add when constructing the context menu for this PasswordEntry.
void	setShowPeekIcon(boolean showPeekIcon)	Sets whether the entry should have a clickable icon to reveal the contents.

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateDefault, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getLimitEvents, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMemoryLayout, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify_, notify_, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gnome.gtk.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updatePlatformState, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface org.gnome.gtk.Editable

delegateGetAccessiblePlatformState, deleteSelection, deleteText, emitChanged, emitDeleteText, emitInsertText, finishDelegate, getAlignment, getChars, getDelegate, getEditable, getEnableUndo, getMaxWidthChars, getPosition, getSelectionBounds, getText, getWidthChars, initDelegate, insertText, onChanged, onDeleteText, onInsertText, selectRegion, setAlignment, setEditable, setEnableUndo, setMaxWidthChars, setPosition, setText, setWidthChars

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

PasswordEntry

public PasswordEntry(MemorySegment address)

Create a PasswordEntry proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

PasswordEntry

public PasswordEntry()

Creates a new PasswordEntry.

Method Details

getType

public static Type getType()

Get the GType of the PasswordEntry class

Returns:

the GType

asParent

protected PasswordEntry asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class Widget

getExtraMenu

public MenuModel getExtraMenu()

Gets the menu model set with gtk_password_entry_set_extra_menu().

Returns:

the menu model

getShowPeekIcon

public boolean getShowPeekIcon()

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

Returns:

true if an icon is shown

setExtraMenu

public void setExtraMenu(@Nullable
 @Nullable MenuModel model)

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

Parameters:

model - a GMenuModel

setShowPeekIcon

public void setShowPeekIcon(boolean showPeekIcon)

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

Setting this to false also hides the text again.

Parameters:

showPeekIcon - whether to show the peek icon

onActivate

public SignalConnection<PasswordEntry.ActivateCallback> onActivate(PasswordEntry.ActivateCallback handler)

Emitted when the entry is activated.

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

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• PasswordEntry.ActivateCallback.run()

emitActivate

public void emitActivate()

Emits the "activate" signal. See onActivate(org.gnome.gtk.PasswordEntry.ActivateCallback).

builder

public static PasswordEntry.Builder<? extends PasswordEntry.Builder> builder()

A PasswordEntry.Builder object constructs a PasswordEntry with the specified properties. Use the various set...() methods to set properties, and finish construction with PasswordEntry.Builder.build().