Struct amethyst_ui::TextEditing

pub struct TextEditing {
    pub cursor_position: isize,
    pub max_length: usize,
    pub highlight_vector: isize,
    pub selected_text_color: [f32; 4],
    pub selected_background_color: [f32; 4],
    pub use_block_cursor: bool,
    // some fields omitted
}

If this component is attached to an entity with a UiText then that UiText is editable. This component also controls how that editing works.

Fields

cursor_position: isize

The current editing cursor position, specified in terms of glyphs, not characters.

max_length: usize

The maximum graphemes permitted in this string.

highlight_vector: isize

The amount and direction of glyphs highlighted relative to the cursor.

selected_text_color: [f32; 4]

The color of the text itself when highlighted.

selected_background_color: [f32; 4]

The text background color when highlighted.

use_block_cursor: bool

If this is true the text will use a block cursor for editing. Otherwise this uses a standard line cursor. This is not recommended if your font is not monospace.

Methods

impl TextEditing

pub fn new(
    max_length: usize,
    selected_text_color: [f32; 4],
    selected_background_color: [f32; 4],
    use_block_cursor: bool
) -> TextEditing

Create a new TextEditing Component

Trait Implementations

impl Copy for TextEditing

impl Clone for TextEditing

fn clone(&self) -> TextEditing

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<TextEditing> for TextEditing

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for TextEditing

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Component for TextEditing

type Storage = DenseVecStorage<Self>

Associated storage type for this component.