Struct TextFieldView 

#[non_exhaustive]
pub struct TextFieldView {
    pub rect: [f32; 4],
    pub value: String,
    pub cursor: usize,
    pub highlight: usize,
    pub max_length: usize,
    pub scroll: usize,
    pub focused: bool,
    pub caret_shown: bool,
    pub bordered: bool,
    pub text_color: u32,
    pub suggestion: Option<String>,
    pub message: String,
}

A text field as DrawContext::widget_text_field draws it: the game’s EditBox look, filled in by Widgets.

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.

value: String

The text.

cursor: usize

The cursor and the other end of the selection, in characters.

highlight: usize

The selection’s anchor.

max_length: usize

The field’s maximum length: a full field shows a bar for its caret.

scroll: usize

The first character shown, from the last draw.

focused: bool

It has the keyboard focus: highlighted sprite, caret, narration.

caret_shown: bool

The caret is in the visible half of its blink.

bordered: bool

On the widget/text_field sprite with a 4-pixel margin.

text_color: u32

The text’s colour, ARGB.

suggestion: Option<String>

Grey text after the end of the text.

message: String

The narrator’s name for it.

Trait Implementations

impl Clone for TextFieldView

fn clone(&self) -> TextFieldView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextFieldView

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

Formats the value using the given formatter.

impl PartialEq for TextFieldView

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TextFieldView

impl Wire for TextFieldView

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<TextFieldView, WireError>

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