Struct glerminal::menu_systems::TextInput

pub struct TextInput {
    pub bg_color_unfocused: [f32; 4],
    pub bg_color_focused: [f32; 4],
    pub fg_color_unfocused: [f32; 4],
    pub fg_color_focused: [f32; 4],
    pub button_press_inputs: Vec<VirtualKeyCode>,
    pub mouse_button_press_inputs: Vec<MouseButton>,
    pub filter: Filter,
    pub caret: f32,
    // some fields omitted
}

Represents a text-input field, that can be focused, takes in events (keyboard events as text), and it's possible to get the input text with get_text

TextInput.filter is used to determine which symbols are registered and then written. Example of a filter that will take in latin alphabetic letters and numerals:

use glerminal::menu_systems::{Filter, TextInput};
use glerminal::VirtualKeyCode::Equals;

let filter = Filter::empty_filter()
    .with_basic_latin_characters() // Add basic latin letters
    .with_basic_numerals()         // Add basic numerals
    .with_pair(Equals, '=');       // Add custom pair

TextInput::new(None, None).with_filter(filter);

Fields

bg_color_unfocused: [f32; 4]

Background-color for when the field is unfocused

bg_color_focused: [f32; 4]

Background-color for when the field is focused

fg_color_unfocused: [f32; 4]

Foreground-color for when the field is unfocused

fg_color_focused: [f32; 4]

Foreground-color for when the field is focused

button_press_inputs: Vec<VirtualKeyCode>

The keyboard inputs that trigger was_just_pressed

mouse_button_press_inputs: Vec<MouseButton>

The mouse inputs that trigger was_just_pressed

filter: Filter

The filter used to determine which button presses are registered for writing

caret: f32

Determines how often (in seconds) the caret's status should update.

Set 0.0 for no caret.

Methods

impl TextInput

pub fn new<T: Into<Option<u32>>, U: Into<Option<u32>>>(     min_width: T,     max_width: U ) -> TextInput

Initializes a new TextInput with the given min and max width

pub fn with_pos(self, pos: (u32, u32)) -> TextInput

Sets the initial position

pub fn with_focused(self, focused: bool) -> TextInput

Set whether the checkbox is initially focused or not

pub fn with_button_press_inputs(self, buttons: Vec<VirtualKeyCode>) -> TextInput

Set the buttons which trigger was_just_pressed

pub fn with_mouse_button_press_inputs(     self,     buttons: Vec<MouseButton> ) -> TextInput

Set the mouse buttons which trigger was_just_pressed

pub fn was_just_pressed(&self) -> bool

Returns whether buttons from mouse_button_press_inputs or button_press_inputs were pressed just now.

pub fn with_unfocused_colors(self, colors: ([f32; 4], [f32; 4])) -> TextInput

Set the initial colors when it is unfocused

pub fn with_focused_colors(self, colors: ([f32; 4], [f32; 4])) -> TextInput

Set the initial colors when it is focused

pub fn set_unfocused_colors(&mut self, colors: ([f32; 4], [f32; 4]))

Set the colors when it is unfocused

pub fn set_focused_colors(&mut self, colors: ([f32; 4], [f32; 4]))

Set the colors when it is focused

pub fn with_width<T: Into<Option<u32>>, U: Into<Option<u32>>>(     self,     min_width: T,     max_width: U ) -> TextInput

Sets the width of the TextInput.

pub fn with_text<T: Into<String>>(self, text: T) -> TextInput

Sets the text of the TextInput.

pub fn with_prefix<T: Into<String>>(self, prefix: T) -> TextInput

Sets the prefix text of the TextInput.

pub fn with_suffix<T: Into<String>>(self, suffix: T) -> TextInput

Sets the suffix text of the TextInput.

pub fn with_filter(self, filter: Filter) -> TextInput

Sets the filter for the TextInput.

pub fn with_caret(self, delay: f32) -> TextInput

Determines how often (in seconds) the caret's status should update.

Set 0.0 for no caret.

pub fn with_character_limit<T: Into<Option<u32>>>(     self,     char_limit: T ) -> TextInput

Limtis the amount of characters that the TextInput will accept.

pub fn set_width<T: Into<Option<u32>>, U: Into<Option<u32>>>(     self,     min_width: T,     max_width: U )

Sets the width of the TextInput.

pub fn set_character_limit<T: Into<Option<u32>>>(self, char_limit: T)

Limtis the amount of characters that the TextInput will accept.

pub fn set_text<T: Into<String>>(&mut self, text: T)

Set the current text

pub fn get_text(&self) -> String

Returns the current text in the input

Trait Implementations

impl InterfaceItem for TextInput

fn get_base(&self) -> &InterfaceItemBase

Get the InterfaceItemBase

fn get_mut_base(&mut self) -> &mut InterfaceItemBase

Get the InterfaceItemBase as mutable

fn get_total_width(&self) -> u32

Get the width this InterfaceItem can take up

fn get_total_height(&self) -> u32

Get the height this InterfaceItem can take up

fn draw(&mut self, text_buffer: &mut TextBuffer)

Draw the InterfaceItem

fn handle_events(&mut self, events: &Events) -> bool

Handle events for this InterfaceItem.

fn update(&mut self, delta: f32)

Update this InterfaceItem; delta is given in seconds. (see Terminal.delta_time())

impl Clone for TextInput

fn clone(&self) -> TextInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextInput

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

Formats the value using the given formatter.