PasswordInput

caretPositionImpl Vector2 caretPositionImpl(float availableWidth, bool preferNextLine): Undocumented in source. Be warned that the author may not have intended to support it.
drawContents void drawContents(Rectangle inner, Rectangle innerScrolled): Undocumented in source. Be warned that the author may not have intended to support it.
drawSelection void drawSelection(Rectangle inner): Draw selection, if applicable.
multiline bool multiline(): PasswordInput does not support multiline.
nearestCharacter size_t nearestCharacter(Vector2 needle): Undocumented in source. Be warned that the author may not have intended to support it.
newBuffer void newBuffer(size_t minimumSize): Request a new or larger buffer.
reloadStyles void reloadStyles(): Undocumented in source. Be warned that the author may not have intended to support it.
shred void shred(): Delete all textual data created by the password box. All text typed inside the box will be overwritten, except for any copies, if they were made. Clears the box.

Mixins

__anonymous mixin enableInputActions: Undocumented in source.

Variables

advance float advance;: Distance between the start positions of each character.
radius float radius;: Character circle radius.

Inherited Members

From TextInput

__anonymous mixin enableInputActions: Undocumented in source.
size auto size;: Size of the field.
placeholder Rope placeholder;: A placeholder text for the field, displayed when the field is empty. Style using emptyStyle.
lastTouch SysTime lastTouch;: Time of the last interaction with the input.
horizontalAnchor float horizontalAnchor;: Reference horizontal (X) position for vertical movement. Relative to the input's top-left corner.
contextMenu PopupFrame contextMenu;: Context menu for this input.
contentLabel ContentLabel contentLabel;: Underlying label controlling the content.
maxHistorySize int maxHistorySize;: Maximum entries in the history.
HistoryEntry struct HistoryEntry: Undocumented in source.
selectionMovement bool selectionMovement;: If true, current movement action is performed while selecting.
_inner Rectangle _inner;: Last padding box assigned to this node, with scroll applied.
_isContinuous bool _isContinuous;: If true, the caret index has not changed since last pushSnapshot.
_undoStack DList!HistoryEntry _undoStack;
_redoStack DList!HistoryEntry _redoStack;: Current action history, expressed as two stacks, indicating undoable and redoable actions, controllable via snapshot, pushSnapshot, undo and redo.
ContentLabel class ContentLabel: Undocumented in source.
touch void touch(): Mark the text input as modified.
touchText void touchText(): Mark the text input as modified and fire the "changed" event.
scrollIntoView ScrollIntoViewAction scrollIntoView(bool alignToTop): Scroll ancestors so the text input becomes visible.
value inout(Rope) value()
Rope value(Rope newValue)
Rope value(const(char)[] value): Value written in the input.
isEmpty bool isEmpty(): If true, this input is currently empty.
multiline bool multiline()
bool multiline(bool value): If true, this input accepts multiple inputs in the input; pressing "enter" will start a new line.
scroll float scroll(): Current horizontal visual offset of the label.
scroll float scroll(float value): Set scroll value.
canScroll bool canScroll(Vector2 value)
pickLabelStyle Style pickLabelStyle(Style style): Get the current style for the label.
pickLabelStyle Style pickLabelStyle(): Undocumented in source. Be warned that the author may not have intended to support it.
valueBeforeCaret Rope valueBeforeCaret()
Rope valueBeforeCaret(Rope newValue)
Rope valueBeforeCaret(const(char)[] newValue): Get or set text preceding the caret.
selectedValue Rope selectedValue()
Rope selectedValue(Rope newValue)
Rope selectedValue(const(char)[] newValue): Get or set currently selected text.
valueAfterCaret Rope valueAfterCaret()
Rope valueAfterCaret(Rope newValue)
Rope valueAfterCaret(const(char)[] value): Get or set text following the caret.
caretPosition Vector2 caretPosition(): Visual position of the caret, relative to the top-left corner of the input.
caretIndex ptrdiff_t caretIndex()
ptrdiff_t caretIndex(ptrdiff_t index): Index of the character, byte-wise.
isSelecting bool isSelecting(): If true, there's an active selection.
selectionLowIndex ptrdiff_t selectionLowIndex(): Low index of the selection, left boundary, first index.
selectionHighIndex ptrdiff_t selectionHighIndex(): High index of the selection, right boundary, second index.
selectionStart ptrdiff_t selectionStart()
ptrdiff_t selectionStart(ptrdiff_t value): Point where selection begins. Caret is the other end of the selection.
selectionEnd alias selectionEnd = caretIndex: Point where selection ends. Corresponds to caret position.
selectSlice void selectSlice(size_t start, size_t end): Select a part of text. This is preferred to setting selectionStart & selectionEnd directly, since the two properties are synchronized together and a change might be ignored.
clearSelection void clearSelection()
moveOrClearSelection void moveOrClearSelection(): Clear selection if selection movement is disabled.
resizeImpl void resizeImpl(Vector2 area): Undocumented in source. Be warned that the author may not have intended to support it.
updateCaretPosition void updateCaretPosition(bool preferNextLine): Update the caret position to match the caret index.
nearestCharacter size_t nearestCharacter(Vector2 needle): Find the closest index to the given position.
buffer inout(char)[] buffer(): Get the current buffer.
usedBufferSize inout(size_t) usedBufferSize(): Get the used size of the buffer.
usedBuffer inout(char)[] usedBuffer(): Get the filled part of the buffer.
freeBuffer inout(char)[] freeBuffer(): Get the empty part of the buffer.
newBuffer void newBuffer(size_t minimumSize): Request a new or a larger buffer.
caretPositionImpl Vector2 caretPositionImpl(float textWidth, bool preferNextLine): Undocumented in source. Be warned that the author may not have intended to support it.
drawImpl void drawImpl(Rectangle outer, Rectangle inner): Undocumented in source. Be warned that the author may not have intended to support it.
drawContents void drawContents(Rectangle inner, Rectangle scrolledInner): Undocumented in source. Be warned that the author may not have intended to support it.
drawCaret void drawCaret(Rectangle inner): Undocumented in source. Be warned that the author may not have intended to support it.
focusBoxImpl Rectangle focusBoxImpl(Rectangle inner): Undocumented in source. Be warned that the author may not have intended to support it.
textRuler TextRuler textRuler(): Get an appropriate text ruler for this input.
drawSelection void drawSelection(Rectangle inner): Draw selection, if applicable.
showCaret bool showCaret(): Undocumented in source. Be warned that the author may not have intended to support it.
keyboardImpl bool keyboardImpl(): Undocumented in source. Be warned that the author may not have intended to support it.
push void push(dchar character)
void push(const(char)[] ch)
void push(Rope text): Push a character or string to the input.
breakLine bool breakLine(): Start a new line
submit void submit(): Submit the input.
chopWord void chopWord(bool forward): Erase last word before the caret, or the first word after.
backspaceWord void backspaceWord(): Remove a word before the caret.
deleteWord void deleteWord(): Delete a word in front of the caret.
chop void chop(bool forward): Erase any character preceding the caret, or the next one.
mouseImpl void mouseImpl(): Undocumented in source. Be warned that the author may not have intended to support it.
scrollImpl void scrollImpl(Vector2 value): Undocumented in source. Be warned that the author may not have intended to support it.
shallowScrollTo Rectangle shallowScrollTo(const(Node) child, Rectangle parentBox, Rectangle childBox): Undocumented in source. Be warned that the author may not have intended to support it.
lineByIndex Rope lineByIndex(size_t index): Get line in the input by a byte index.
lineByIndex const(char)[] lineByIndex(size_t index, const(char)[] value)
Rope lineByIndex(size_t index, Rope newValue): Update a line with given byte index.
lineStartByIndex size_t lineStartByIndex(size_t index)
lineEndByIndex size_t lineEndByIndex(size_t index): Get the index of the start or end of the line — from index of any character on the same line.
caretLine Rope caretLine(): Get the current line
caretLine const(char)[] caretLine(const(char)[] newValue)
Rope caretLine(Rope newValue): Change the current line. Moves the cursor to the end of the newly created line.
column ptrdiff_t column(ptrdiff_t index)
ptrdiff_t column(): Get the column the given index (or the cursor, if omitted) is on.
eachLineByIndex auto eachLineByIndex(ptrdiff_t start, ptrdiff_t end): Iterate on each line in an interval.
eachSelectedLine auto eachSelectedLine(): Return each line containing the selection.
openContextMenu void openContextMenu(): Open the input's context menu.
backspace void backspace(): Remove a character before the caret. Same as chop.
deleteChar void deleteChar(): Delete one character in front of the cursor.
clear void clear(): Clear the value of this input field, making it empty.
selectWord void selectWord(): Select the word surrounding the cursor. If selection is active, expands selection to cover words.
selectLine void selectLine(): Select the whole line the cursor is.
previousOrNextChar void previousOrNextChar(FluidInputAction action): Move caret to the previous or next character.
previousOrNextWord void previousOrNextWord(FluidInputAction action): Move caret to the previous or next word.
previousOrNextLine void previousOrNextLine(FluidInputAction action): Move the caret to the previous or next line.
caretTo void caretTo(Vector2 position): Move the caret to the given screen position (viewport space).
caretToMouse void caretToMouse(): Move the caret to mouse position.
caretToLineStart void caretToLineStart(): Move the caret to the beginning of the line. This function perceives the line visually, so if the text wraps, it will go to the beginning of the visible line, instead of the hard line break.
caretToLineEnd void caretToLineEnd(): Move the caret to the end of the line.
caretToStart void caretToStart(): Move the caret to the beginning of the input
caretToEnd void caretToEnd(): Move the caret to the end of the input
selectAll void selectAll(): Select all text
select void select(FluidInputAction action): Begin or continue selection using given movement action.
cut void cut(): Cut selected text to clipboard, clearing the selection.
copy void copy(): Copy selected text to clipboard.
paste void paste(): Paste text from clipboard.
clearHistory void clearHistory(): Clear the undo/redo action history.
pushSnapshot void pushSnapshot(HistoryEntry entry)
forcePushSnapshot void forcePushSnapshot(HistoryEntry entry): Push the given state snapshot (value, caret & selection) into the undo stack. Refuses to push if the current state can be merged with it, unless forcePushSnapshot is used.
snapshot HistoryEntry snapshot(): Produce a snapshot for the current state. Returns the snapshot.
snapshot HistoryEntry snapshot(HistoryEntry entry): Restore state from snapshot
undo void undo(): Restore the last value in history.
redo void redo(): Perform the last undone action again.

Examples

// PasswordInput lets you ask the user for passwords
auto node = passwordInput();

// Retrieve the password with `value`
auto userPassword = node.value;

// Destroy the passwords once you're done to secure them against attacks
// (Careful: This will invalidate `userPassword` we got earlier)
node.shred();

PasswordInput

Constructors

Members

Functions

Mixins

Variables

Inherited Members

From TextInput

Examples

Meta

Source