Struct amethyst_ui::TextEditingInputSystem

pub struct TextEditingInputSystem { /* fields omitted */ }

System managing the keyboard inputs for the editable text fields.

Features

• Adds and removes text.
• Moves selection cursor.
• Grows and shrinks selected text zone.

Methods

impl TextEditingInputSystem

pub fn new(reader: ReaderId<Event>) -> Self

Creates a new instance of this system

Trait Implementations

impl Debug for TextEditingInputSystem

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

Formats the value using the given formatter.

impl<'system_desc_a, 'system_desc_b> SystemDesc<'system_desc_a, 'system_desc_b, TextEditingInputSystem> for TextEditingInputSystemDesc

fn build(self, world: &mut World) -> TextEditingInputSystem

Builds and returns a System.

impl<'a> System<'a> for TextEditingInputSystem

type SystemData = (Entities<'a>, WriteStorage<'a, UiText>, WriteStorage<'a, TextEditing>, ReadStorage<'a, Selected>, Read<'a, EventChannel<Event>>, Write<'a, EventChannel<UiEvent>>)

The resource bundle required to execute this system.

fn run(
    &mut self,
    (entities, texts, editables, selecteds, events, edit_events): Self::SystemData
)

Executes the system with the required system data.

fn running_time(&self) -> RunningTime

Returns a hint how long the system needs for running. This is used to optimize the way they're executed (might allow more parallelization).

fn accessor(&'b self) -> AccessorCow<'a, 'b, Self>

Return the accessor from the [SystemData].

fn setup(&mut self, world: &mut World)

Sets up the World using Self::SystemData::setup.

fn dispose(self, world: &mut World)

Performs clean up that requires resources from the World. This commonly removes components from world which depend on external resources.