Struct Textbox 

pub struct Textbox { /* private fields */ }

Single-line text input method Allows navigating through the string, removing (using Backspace) and adding characters at the ‘_’ sign The cursor will hide the grapheme behind it

Design (including Border):

┌─────┐
│Tex_1│
└─────┘

Implementations

impl Textbox

pub const DELAY_DEFAULT: Duration

pub const CURSOR: Grapheme

pub const CURSOR_WIDE: Grapheme

pub fn default_callback(_: &mut Self)

pub fn default_key_handler(&mut self, event: &mut WindowEvent)

pub fn set_text_changed_callback<F: Fn(&mut Self) + 'static>( &mut self, callback: F, )

pub fn set_callback_delay(&mut self, duration: Duration)

pub fn set_key_handler(&mut self, f: TextboxKeyHandler)

pub fn set_cursor_type(&mut self, fat_cursor: bool)

fat_cursor: true will just highlight the current position, false will use _ instead as cursor

pub fn set_focus_color(&mut self, focus_color: Option<Color>)

Foreground color when the textbox has focus

pub fn is_readonly(&self) -> bool

pub fn set_readonly(&mut self, readonly: bool)

pub fn get_max_length(&self) -> usize

Returns the maximum length of the inner text

pub fn set_max_length(&mut self, length: usize)

Sets the maximum length of the inner text (number of graphemes)

pub fn get_text(&self) -> &str

Returns the inner text

pub fn set_text(&mut self, text: &str)

Updates the inner text

pub fn clear(&mut self)

Clears the inner text

pub fn move_cursor_left(&mut self)

pub fn move_cursor_right(&mut self)

pub fn remove_glyph_before_cursor(&mut self)

pub fn insert_char_at_cursor(&mut self, ch: char)

Trait Implementations

impl Default for Textbox

fn default() -> Self

Returns the “default value” for a type.

impl HasWindowUID for Textbox

fn uid(&self) -> WindowUID

Must be static and unique for each object implementing Window. Generate once per instance using WindowUID::new.

impl Widget for Textbox

fn set_alignment( &mut self, horizontal: HorizontalAlignment, vertical: VerticalAlignment, )

fn set_visibility(&mut self, visibility: bool)

fn set_width(&mut self, width: Size)

fn set_height(&mut self, _: Size)

fn set_margin(&mut self, margin: Thickness)

fn set_border(&mut self, border: BorderStyle)

fn set_enabled_state(&mut self, is_enabled: bool)

Changing the IsEnabled state usually changes the highlight color

fn set_width_constraint(&mut self, width: SizeConstraint)

fn set_height_constraint(&mut self, _: SizeConstraint)

impl WidgetColors for Textbox

fn set_disabled_color(&mut self, color: Option<Color>)

fn set_base_fg_color(&mut self, color: Option<Color>)

fn set_base_bg_color(&mut self, color: Option<Color>)

impl Window for Textbox

fn render(&self, canvas: &mut Canvas)

Allows self to draw into its own Canvas The canvas size depends on other properties set and the terminal size itself It is guarenteed that the size of the Canvas is atleast 1x1

fn handle_event(&mut self, event: &mut WindowEvent)

The events are forwarded from crossterm with the only exception of Resize which will have the same dimensions as the resulting canvas If a event’s handled attributed is set to true it will stop bubbling otherwise it will keep bubbling until another Window marks it as handled Except for:

fn is_enabled(&self) -> bool

Is self enabled? Indicated whether or not to handle input and if its focusable When false, Window is still eligible to receive events

fn children(&mut self, builder: SubWindowBuilder) -> SubWindows

Returns all children windows (and layouting Rects) Note: When changing the children make sure to also adjust the focus

fn focus(&self) -> Option<WindowRef>

Which child of the window has focus Is there is None, then ´self´ has focus

impl WindowLayout for Textbox

fn desired_size(&self, available_size: TPoint) -> TPoint

Parents call this to get the desired size of the child This must not exceed available_size on any axis When the result’s product is equal to 0, this window wont be drawn

fn alignment(&self) -> (HorizontalAlignment, VerticalAlignment)

Aligns self within its parent Window

fn margin(&self) -> Thickness

fn border(&self) -> BorderStyle

fn is_visible(&self) -> bool

fn desired_size_pre_hook(&mut self, available_size: TPoint)

This is similar to desired_size but will not return anything and can mutably change self This is executed before WindowLayout::desired_size Only implement if actually necessary