Struct termimad::InputField

pub struct InputField {
    pub area: Area,
    pub focused: bool,
    // some fields omitted
}

A simple input field, managing its cursor position and either handling the events you give it or being managed through direct manipulation functions (put_char, del_char_left, etc.)

Fields

area: Area

focused: bool

Implementations

impl InputField

pub fn new(area: Area) -> Self

pub fn change_area(&mut self, x: u16, y: u16, w: u16)

pub fn set_normal_style(&mut self, style: CompoundStyle)

pub fn get_content(&self) -> String

pub fn is_content(&self, s: &str) -> bool

tell whether the content of the input is equal to the argument

pub fn set_content(&mut self, s: &str)

change the content to the new one and put the cursor at the end if the content is different from the previous one.

pub fn put_char(&mut self, c: char) -> bool

put a char at cursor position (and increment this position)

pub fn del_char_left(&mut self) -> bool

remove the char left of the cursor, if any

pub fn del_char_below(&mut self) -> bool

remove the char at cursor position, if any

pub fn move_right(&mut self) -> bool

pub fn move_left(&mut self) -> bool

pub fn move_to_end(&mut self) -> bool

pub fn move_to_start(&mut self) -> bool

pub fn move_word_left(&mut self) -> bool

pub fn move_word_right(&mut self) -> bool

pub fn del_word_left(&mut self) -> bool

pub fn del_word_right(&mut self) -> bool

delete the word rigth of the cursor.

pub fn apply_keycode_event(&mut self, code: KeyCode) -> bool

apply an event being a key without modifier.

You don’t usually call this function but the more general apply_event. This one is useful when you manage events mostly yourselves.

This function handles a few events like deleting a char, or going to the start (home key) or end (end key) of the input. If you want to totally handle events, you may call function like put_char and del_char_left directly.

pub fn apply_click_event(&mut self, x: u16, y: u16) -> bool

apply a click event

(for when you handle the events yourselves and don’t have a termimad event)

pub fn apply_event(&mut self, event: &Event) -> bool

apply the passed event to change the state (content, cursor)

Return true when the event was used.

pub fn display_on<W>(&self, w: &mut W) -> Result<(), Error> where
    W: Write, 

render the input field on screen.

All rendering must be explicitely called, no rendering is done on functions changing the state.

w is typically either stderr or stdout.

pub fn display(&self) -> Result<(), Error>

render the input field on stdout