Struct orbtk::widgets::TextBox

pub struct TextBox {
    pub rect: Cell<Rect>,
    pub selector: CloneCell<Selector>,
    pub text: CloneCell<String>,
    pub text_i: Cell<usize>,
    pub text_offset: Cell<Point>,
    pub scroll_offset: Cell<(i32, i32)>,
    pub mask_char: Cell<Option<char>>,
    pub grab_focus: Cell<bool>,
    pub click_callback: RefCell<Option<Arc<dyn Fn(&TextBox, Point)>>>,
    pub enter_callback: RefCell<Option<Arc<dyn Fn(&TextBox)>>>,
    pub event_filter: RefCell<Option<Arc<dyn Fn(&TextBox, Event, &mut bool, &mut bool) -> Option<Event>>>>,
    // some fields omitted
}

Fields

rect: Cell<Rect>

selector: CloneCell<Selector>

text: CloneCell<String>

text_i: Cell<usize>

text_offset: Cell<Point>

scroll_offset: Cell<(i32, i32)>

mask_char: Cell<Option<char>>

grab_focus: Cell<bool>

click_callback: RefCell<Option<Arc<dyn Fn(&TextBox, Point)>>>

enter_callback: RefCell<Option<Arc<dyn Fn(&TextBox)>>>

event_filter: RefCell<Option<Arc<dyn Fn(&TextBox, Event, &mut bool, &mut bool) -> Option<Event>>>>

If event_filter is defined, all of the events will go trough it Instead of the default behavior. This allows defining fields that ex. will only accept numbers and ignore all else, or add some special behavior for some keys.

The closure should return None if the event was manually handled, or should return the event it received if it wants the default handler deal with it.

Methods

impl TextBox

pub fn new() -> Arc<Self>

pub fn grab_focus(&self, grab_focus: bool) -> &Self

pub fn mask_char(&self, mask_char: Option<char>) -> &Self

Trait Implementations

impl Click for TextBox

fn emit_click(&self, point: Point)

fn on_click<T: Fn(&Self, Point) + 'static>(&self, func: T) -> &Self

impl Enter for TextBox

fn emit_enter(&self)

fn on_enter<T: Fn(&Self) + 'static>(&self, func: T) -> &Self

impl EventFilter for TextBox

fn handle_event(
    &self,
    event: Event,
    focused: &mut bool,
    redraw: &mut bool
) -> Option<Event>

fn event_filter<T: Fn(&Self, Event, &mut bool, &mut bool) -> Option<Event> + 'static>(
    &self,
    func: T
) -> &Self

impl Place for TextBox

fn position(&self, x: i32, y: i32) -> &Self

fn size(&self, width: u32, height: u32) -> &Self

fn placement(
    &self,
    vertical_placement: VerticalPlacement,
    horizontal_placement: HorizontalPlacement
) -> &Self

impl Text for TextBox

fn text<S: Into<String>>(&self, text: S) -> &Self

fn text_offset(&self, x: i32, y: i32) -> &Self

impl Style for TextBox

fn selector(&self) -> &CloneCell<Selector>

fn with_class<S: Into<String>>(&self, class: S) -> &Self

fn without_class<S: Into<String>>(&self, class: S) -> &Self

fn with_pseudo_class<S: Into<String>>(&self, pseudo_class: S) -> &Self

fn without_pseudo_class<S: Into<String>>(&self, pseudo_class: S) -> &Self

impl Widget for TextBox

fn name(&self) -> &str

Return the name of the widget.

fn rect(&self) -> &Cell<Rect>

Borrow the render rect of the widget.

fn local_position(&self) -> &Cell<Point>

Borrow the local position of the widget. The local position describes position of the widget relative to it's parent.

fn vertical_placement(&self) -> &Cell<VerticalPlacement>

Borrow the vertical placement of the widget.

fn horizontal_placement(&self) -> &Cell<HorizontalPlacement>

Borrow the horizontal placement of the widget.

fn margin(&self) -> &Cell<Thickness>

Borrow the margin of the widget.

fn draw(&self, renderer: &mut dyn Renderer, focused: bool, theme: &Theme)

Used to draw the widget by render code.

fn event(
    &self,
    event: Event,
    focused: bool,
    redraw: &mut bool,
    caught: &mut bool
) -> bool

Handle the incoming events by bubbling from child to parent. Must have overwritten to create a custom bubbling event handling.

fn children(&self) -> &RefCell<Vec<Arc<dyn Widget>>>

Borrow the children of the widget.

fn preview_event(
    &self,
    _event: Event,
    _focused: bool,
    _redraw: &mut bool,
    _handled: bool
) -> bool

Handle the incoming events by tunneling from parent to child. Must have overwritten to create a custom tunneling event handling.

fn add(&self, widget: Arc<dyn Widget>)

Add a child to the widget.

fn update(&self)

Used to update the state of the widget. Could be used to update the selector.

fn arrange(&self)

Arrange the children of the widget. Could be override to create a custom layout.