Struct nannou::ui::widget::TextBox

pub struct TextBox<'a> { /* fields omitted */ }

A widget for displaying and mutating a small, one-line field of text, given by the user in the form of a String.

It's reaction is triggered upon pressing of the Enter/Return key.

Methods

impl<'a> TextBox<'a>

pub fn new(text: &'a str) -> TextBox<'a>

Construct a TextBox widget.

pub fn left_justify(self) -> TextBox<'a>

Align the text to the left of its bounding Rect's x axis range.

pub fn center_justify(self) -> TextBox<'a>

Align the text to the middle of its bounding Rect's x axis range.

pub fn right_justify(self) -> TextBox<'a>

Align the text to the right of its bounding Rect's x axis range.

pub fn font_id(self, font_id: Id) -> TextBox<'a>

Specify the font used for displaying the text.

pub fn text_color(self, text_color: Color) -> TextBox<'a>

Build the type's self.$($assignee).+ with the given $Type.

pub fn font_size(self, font_size: u32) -> TextBox<'a>

Build the type's self.$($assignee).+ with the given $Type.

pub fn justify(self, justify: Justify) -> TextBox<'a>

Build the type's self.$($assignee).+ with the given $Type.

pub fn pad_text(self, pad_text: f64) -> TextBox<'a>

Build the type's self.$($assignee).+ with the given $Type.

Trait Implementations

impl<'a> Borderable for TextBox<'a>

fn border(self, border: f64) -> TextBox<'a>

Build the type's self.$($assignee).+ with the given $Type.

fn border_color(self, border_color: Color) -> TextBox<'a>

Build the type's self.$($assignee).+ with the given $Type.

fn border_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self

Set the color of the widget's border with rgba values.

fn border_rgb(self, r: f32, g: f32, b: f32) -> Self

Set the color of the widget's border with rgb values.

fn border_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self

Set the color of the widget's border with hsla values.

fn border_hsl(self, h: f32, s: f32, l: f32) -> Self

Set the color of the widget's border with hsl values.

impl<'a> Colorable for TextBox<'a>

fn color(self, color: Color) -> TextBox<'a>

Build the type's self.$($assignee).+ with the given $Type.

fn rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self

Set the color of the widget from rgba values.

fn rgb(self, r: f32, g: f32, b: f32) -> Self

Set the color of the widget from rgb values.

fn hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self

Set the color of the widget from hsla values.

fn hsl(self, h: f32, s: f32, l: f32) -> Self

Set the color of the widget from hsl values.

impl<'a> Common for TextBox<'a>

fn common(&self) -> &CommonBuilder

Borrows the CommonBuilder field.

fn common_mut(&mut self) -> &mut CommonBuilder

Mutably borrows the CommonBuilder field.

impl<'a> Widget for TextBox<'a>

type State = State

State to be stored within the Uis widget cache.

type Style = Style

Every widget is required to have its own associated Style type. This type is intended to contain high-level styling information for the widget that can be optionally specified by a user of the widget.

type Event = Vec<Event>

The type of event yielded by the widget, returned via the Widget::set function.

fn init_state(&self, id_gen: Generator) -> <TextBox<'a> as Widget>::State

Return the initial State of the Widget.

fn style(&self) -> <TextBox<'a> as Widget>::Style

Return the styling of the widget.

fn update(self, args: UpdateArgs<TextBox<'a>>) -> <TextBox<'a> as Widget>::Event

Update the state of the TextEdit.

fn default_x_position(&self, ui: &Ui) -> Position

The default Position for the widget along the x axis.

fn default_y_position(&self, ui: &Ui) -> Position

The default Position for the widget along the y axis.

fn default_x_dimension(&self, ui: &Ui) -> Dimension

The default width for the Widget.

fn default_y_dimension(&self, ui: &Ui) -> Dimension

The default height of the widget.

fn drag_area(
    &self,
    _dim: [f64; 2],
    _style: &Self::Style,
    _theme: &Theme
) -> Option<Rect>

If the widget is draggable, implement this method and return the position and dimensions of the draggable space. The position should be relative to the center of the widget.

fn kid_area(&self, args: KidAreaArgs<Self>) -> KidArea

The area on which child widgets will be placed when using the Place Position methods.

fn is_over(&self) -> fn(&Container, [f64; 2], &Theme) -> IsOver

Returns either of the following:

fn parent(self, parent_id: NodeIndex<u32>) -> Self

Set the parent widget for this Widget by passing the WidgetId of the parent.

fn no_parent(self) -> Self

Specify that this widget has no parent widgets.

fn place_on_kid_area(self, b: bool) -> Self

Set whether or not the Widget should be placed on the kid_area.

fn graphics_for(self, id: NodeIndex<u32>) -> Self

Indicates that the Widget is used as a non-interactive graphical element for some other widget.

fn floating(self, is_floating: bool) -> Self

Set whether or not the widget is floating (the default is false). A typical example of a floating widget would be a pop-up or alert window.

fn crop_kids(self) -> Self

Indicates that all widgets who are children of this widget should be cropped to the kid_area of this widget.

fn scroll_kids(self) -> Self

Makes the widget's KidArea scrollable.

fn scroll_kids_vertically(self) -> Self

Makes the widget's KidArea scrollable.

fn scroll_kids_horizontally(self) -> Self

Set whether or not the widget's KidArea is scrollable (the default is false).

fn and<F>(self, build: F) -> Self where
    F: FnOnce(Self) -> Self, 

A builder method that "lifts" the Widget through the given build function.

fn and_mut<F>(self, mutate: F) -> Self where
    F: FnOnce(&mut Self), 

A builder method that mutates the Widget with the given mutate function.

fn and_if<F>(self, cond: bool, build: F) -> Self where
    F: FnOnce(Self) -> Self, 

A method that conditionally builds the Widget with the given build function.

fn and_then<T, F>(self, maybe: Option<T>, build: F) -> Self where
    F: FnOnce(Self, T) -> Self, 

A method that optionally builds the Widget with the given build function.

fn set(self, id: NodeIndex<u32>, ui_cell: &'a mut UiCell<'b>) -> Self::Event

Note: There should be no need to override this method.