Struct TextField 

#[non_exhaustive]
pub struct TextField {
    pub rect: [f32; 4],
    pub edit: TextEdit,
    pub active: bool,
    pub bordered: bool,
    pub text_color: u32,
    pub suggestion: Option<String>,
    pub message: String,
    /* private fields */
}

A single-line text field (EditBox).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rect: [f32; 4]

Where it is, [x, y, width, height] in GUI pixels (vanilla’s are 20 high).

edit: TextEdit

The text, cursor and selection.

active: bool

An inactive field shows its text greyed out, takes no input and is skipped by Tab.

bordered: bool

Drawn on the widget/text_field sprite with a 4-pixel margin; without, the bare text.

text_color: u32

The text’s colour, ARGB (EditBox.setTextColor).

suggestion: Option<String>

Grey text shown after the end of the text (EditBox.setSuggestion).

message: String

What the narrator calls it (EditBox’s message: <message> edit box: <text>).

Implementations

impl TextField

pub fn new(rect: [f32; 4], max_length: usize) -> TextField

An empty, active, bordered field that takes up to max_length characters.

pub fn value(&self) -> &str

The text.

pub fn set_value(&mut self, value: &str)

EditBox.setValue: the text, cut to the maximum length, with the cursor at its end.

Trait Implementations

impl Clone for TextField

fn clone(&self) -> TextField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextField

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

Formats the value using the given formatter.

impl PartialEq for TextField

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TextField

impl Wire for TextField

const MIN: usize

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.

fn take(input: &mut Reader<'_>) -> Result<TextField, WireError>

Decodes one value, leaving any following bytes for the caller.