[−][src]Struct nannou::ui::widget::TextBox
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>
[src]
pub fn new(text: &'a str) -> TextBox<'a>
[src]
Construct a TextBox widget.
pub fn left_justify(self) -> TextBox<'a>
[src]
Align the text to the left of its bounding Rect's x axis range.
pub fn center_justify(self) -> TextBox<'a>
[src]
Align the text to the middle of its bounding Rect's x axis range.
pub fn right_justify(self) -> TextBox<'a>
[src]
Align the text to the right of its bounding Rect's x axis range.
pub fn font_id(self, font_id: Id) -> TextBox<'a>
[src]
Specify the font used for displaying the text.
pub fn text_color(self, text_color: Color) -> TextBox<'a>
[src]
Build the type's self.$($assignee).+ with the given $Type.
pub fn font_size(self, font_size: u32) -> TextBox<'a>
[src]
Build the type's self.$($assignee).+ with the given $Type.
pub fn justify(self, justify: Justify) -> TextBox<'a>
[src]
Build the type's self.$($assignee).+ with the given $Type.
pub fn pad_text(self, pad_text: f64) -> TextBox<'a>
[src]
Build the type's self.$($assignee).+ with the given $Type.
Trait Implementations
impl<'a> Borderable for TextBox<'a>
[src]
fn border(self, border: f64) -> TextBox<'a>
[src]
Build the type's self.$($assignee).+ with the given $Type.
fn border_color(self, border_color: Color) -> TextBox<'a>
[src]
Build the type's self.$($assignee).+ with the given $Type.
fn border_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
[src]
fn border_rgb(self, r: f32, g: f32, b: f32) -> Self
[src]
fn border_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
[src]
fn border_hsl(self, h: f32, s: f32, l: f32) -> Self
[src]
impl<'a> Colorable for TextBox<'a>
[src]
fn color(self, color: Color) -> TextBox<'a>
[src]
Build the type's self.$($assignee).+ with the given $Type.
fn rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
[src]
fn rgb(self, r: f32, g: f32, b: f32) -> Self
[src]
fn hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
[src]
fn hsl(self, h: f32, s: f32, l: f32) -> Self
[src]
impl<'a> Common for TextBox<'a>
[src]
fn common(&self) -> &CommonBuilder
[src]
fn common_mut(&mut self) -> &mut CommonBuilder
[src]
impl<'a> Widget for TextBox<'a>
[src]
type State = State
State to be stored within the Ui
s widget cache. Read more
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. Read more
type Event = Vec<Event>
The type of event yielded by the widget, returned via the Widget::set
function. Read more
fn init_state(&self, id_gen: Generator) -> <TextBox<'a> as Widget>::State
[src]
fn style(&self) -> <TextBox<'a> as Widget>::Style
[src]
fn update(self, args: UpdateArgs<TextBox<'a>>) -> <TextBox<'a> as Widget>::Event
[src]
Update the state of the TextEdit.
fn default_x_position(&self, ui: &Ui) -> Position
[src]
fn default_y_position(&self, ui: &Ui) -> Position
[src]
fn default_x_dimension(&self, ui: &Ui) -> Dimension
[src]
fn default_y_dimension(&self, ui: &Ui) -> Dimension
[src]
fn drag_area(
&self,
_dim: [f64; 2],
_style: &Self::Style,
_theme: &Theme
) -> Option<Rect>
[src]
&self,
_dim: [f64; 2],
_style: &Self::Style,
_theme: &Theme
) -> Option<Rect>
fn kid_area(&self, args: KidAreaArgs<Self>) -> KidArea
[src]
fn is_over(&self) -> fn(&Container, [f64; 2], &Theme) -> IsOver
[src]
fn parent(self, parent_id: NodeIndex<u32>) -> Self
[src]
fn no_parent(self) -> Self
[src]
fn place_on_kid_area(self, b: bool) -> Self
[src]
fn graphics_for(self, id: NodeIndex<u32>) -> Self
[src]
fn floating(self, is_floating: bool) -> Self
[src]
fn crop_kids(self) -> Self
[src]
fn scroll_kids(self) -> Self
[src]
fn scroll_kids_vertically(self) -> Self
[src]
fn scroll_kids_horizontally(self) -> Self
[src]
fn and<F>(self, build: F) -> Self where
F: FnOnce(Self) -> Self,
[src]
F: FnOnce(Self) -> Self,
fn and_mut<F>(self, mutate: F) -> Self where
F: FnOnce(&mut Self),
[src]
F: FnOnce(&mut Self),
fn and_if<F>(self, cond: bool, build: F) -> Self where
F: FnOnce(Self) -> Self,
[src]
F: FnOnce(Self) -> Self,
fn and_then<T, F>(self, maybe: Option<T>, build: F) -> Self where
F: FnOnce(Self, T) -> Self,
[src]
F: FnOnce(Self, T) -> Self,
fn set(self, id: NodeIndex<u32>, ui_cell: &'a mut UiCell<'b>) -> Self::Event
[src]
Auto Trait Implementations
impl<'a> RefUnwindSafe for TextBox<'a>
impl<'a> Send for TextBox<'a>
impl<'a> Sync for TextBox<'a>
impl<'a> Unpin for TextBox<'a>
impl<'a> UnwindSafe for TextBox<'a>
Blanket Implementations
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
D: AdaptFrom<S, Swp, Dwp, T>,
Dwp: WhitePoint,
Swp: WhitePoint,
T: Component + Float,
[src]
D: AdaptFrom<S, Swp, Dwp, T>,
Dwp: WhitePoint,
Swp: WhitePoint,
T: Component + Float,
fn adapt_into_using<M>(self, method: M) -> D where
M: TransformMatrix<Swp, Dwp, T>,
[src]
M: TransformMatrix<Swp, Dwp, T>,
fn adapt_into(self) -> D
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> ConvertInto<U> for T where
U: ConvertFrom<T>,
[src]
U: ConvertFrom<T>,
fn convert_into(self) -> U
[src]
fn convert_unclamped_into(self) -> U
[src]
fn try_convert_into(self) -> Result<U, OutOfBounds<U>>
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<W> Positionable for W where
W: Widget,
[src]
W: Widget,
fn x_position(self, x: Position) -> W
[src]
fn y_position(self, y: Position) -> W
[src]
fn get_x_position(&self, ui: &Ui) -> Position
[src]
fn get_y_position(&self, ui: &Ui) -> Position
[src]
fn depth(self, depth: f32) -> W
[src]
fn get_depth(&self) -> f32
[src]
fn x(self, x: f64) -> Self
[src]
fn y(self, y: f64) -> Self
[src]
fn xy(self, point: [f64; 2]) -> Self
[src]
fn x_y(self, x: f64, y: f64) -> Self
[src]
fn x_position_relative(self, x: Relative) -> Self
[src]
fn y_position_relative(self, y: Relative) -> Self
[src]
fn x_y_position_relative(self, x: Relative, y: Relative) -> Self
[src]
fn x_position_relative_to(self, other: NodeIndex<u32>, x: Relative) -> Self
[src]
fn y_position_relative_to(self, other: NodeIndex<u32>, y: Relative) -> Self
[src]
fn x_y_position_relative_to(
self,
other: NodeIndex<u32>,
x: Relative,
y: Relative
) -> Self
[src]
self,
other: NodeIndex<u32>,
x: Relative,
y: Relative
) -> Self
fn x_relative(self, x: f64) -> Self
[src]
fn y_relative(self, y: f64) -> Self
[src]
fn xy_relative(self, point: [f64; 2]) -> Self
[src]
fn x_y_relative(self, x: f64, y: f64) -> Self
[src]
fn x_relative_to(self, other: NodeIndex<u32>, x: f64) -> Self
[src]
fn y_relative_to(self, other: NodeIndex<u32>, y: f64) -> Self
[src]
fn xy_relative_to(self, other: NodeIndex<u32>, xy: [f64; 2]) -> Self
[src]
fn x_y_relative_to(self, other: NodeIndex<u32>, x: f64, y: f64) -> Self
[src]
fn x_direction(self, direction: Direction, x: f64) -> Self
[src]
fn y_direction(self, direction: Direction, y: f64) -> Self
[src]
fn down(self, y: f64) -> Self
[src]
fn up(self, y: f64) -> Self
[src]
fn left(self, x: f64) -> Self
[src]
fn right(self, x: f64) -> Self
[src]
fn x_direction_from(
self,
other: NodeIndex<u32>,
direction: Direction,
x: f64
) -> Self
[src]
self,
other: NodeIndex<u32>,
direction: Direction,
x: f64
) -> Self
fn y_direction_from(
self,
other: NodeIndex<u32>,
direction: Direction,
y: f64
) -> Self
[src]
self,
other: NodeIndex<u32>,
direction: Direction,
y: f64
) -> Self
fn down_from(self, other: NodeIndex<u32>, y: f64) -> Self
[src]
fn up_from(self, other: NodeIndex<u32>, y: f64) -> Self
[src]
fn left_from(self, other: NodeIndex<u32>, x: f64) -> Self
[src]
fn right_from(self, other: NodeIndex<u32>, x: f64) -> Self
[src]
fn x_align(self, align: Align) -> Self
[src]
fn y_align(self, align: Align) -> Self
[src]
fn align_left(self) -> Self
[src]
fn align_middle_x(self) -> Self
[src]
fn align_right(self) -> Self
[src]
fn align_top(self) -> Self
[src]
fn align_middle_y(self) -> Self
[src]
fn align_bottom(self) -> Self
[src]
fn x_align_to(self, other: NodeIndex<u32>, align: Align) -> Self
[src]
fn y_align_to(self, other: NodeIndex<u32>, align: Align) -> Self
[src]
fn align_left_of(self, other: NodeIndex<u32>) -> Self
[src]
fn align_middle_x_of(self, other: NodeIndex<u32>) -> Self
[src]
fn align_right_of(self, other: NodeIndex<u32>) -> Self
[src]
fn align_top_of(self, other: NodeIndex<u32>) -> Self
[src]
fn align_middle_y_of(self, other: NodeIndex<u32>) -> Self
[src]
fn align_bottom_of(self, other: NodeIndex<u32>) -> Self
[src]
fn x_place_on(self, other: NodeIndex<u32>, place: Place) -> Self
[src]
fn y_place_on(self, other: NodeIndex<u32>, place: Place) -> Self
[src]
fn middle_of(self, other: NodeIndex<u32>) -> Self
[src]
fn top_left_of(self, other: NodeIndex<u32>) -> Self
[src]
fn top_left_with_margin_on(self, other: NodeIndex<u32>, mgn: f64) -> Self
[src]
fn top_left_with_margins_on(
self,
other: NodeIndex<u32>,
top: f64,
left: f64
) -> Self
[src]
self,
other: NodeIndex<u32>,
top: f64,
left: f64
) -> Self
fn top_right_of(self, other: NodeIndex<u32>) -> Self
[src]
fn top_right_with_margin_on(self, other: NodeIndex<u32>, mgn: f64) -> Self
[src]
fn top_right_with_margins_on(
self,
other: NodeIndex<u32>,
top: f64,
right: f64
) -> Self
[src]
self,
other: NodeIndex<u32>,
top: f64,
right: f64
) -> Self
fn bottom_left_of(self, other: NodeIndex<u32>) -> Self
[src]
fn bottom_left_with_margin_on(self, other: NodeIndex<u32>, mgn: f64) -> Self
[src]
fn bottom_left_with_margins_on(
self,
other: NodeIndex<u32>,
bottom: f64,
left: f64
) -> Self
[src]
self,
other: NodeIndex<u32>,
bottom: f64,
left: f64
) -> Self
fn bottom_right_of(self, other: NodeIndex<u32>) -> Self
[src]
fn bottom_right_with_margin_on(self, other: NodeIndex<u32>, mgn: f64) -> Self
[src]
fn bottom_right_with_margins_on(
self,
other: NodeIndex<u32>,
bottom: f64,
right: f64
) -> Self
[src]
self,
other: NodeIndex<u32>,
bottom: f64,
right: f64
) -> Self
fn mid_top_of(self, other: NodeIndex<u32>) -> Self
[src]
fn mid_top_with_margin_on(self, other: NodeIndex<u32>, mgn: f64) -> Self
[src]
fn mid_bottom_of(self, other: NodeIndex<u32>) -> Self
[src]
fn mid_bottom_with_margin_on(self, other: NodeIndex<u32>, mgn: f64) -> Self
[src]
fn mid_left_of(self, other: NodeIndex<u32>) -> Self
[src]
fn mid_left_with_margin_on(self, other: NodeIndex<u32>, mgn: f64) -> Self
[src]
fn mid_right_of(self, other: NodeIndex<u32>) -> Self
[src]
fn mid_right_with_margin_on(self, other: NodeIndex<u32>, mgn: f64) -> Self
[src]
fn x_place(self, place: Place) -> Self
[src]
fn y_place(self, place: Place) -> Self
[src]
fn middle(self) -> Self
[src]
fn top_left(self) -> Self
[src]
fn top_left_with_margin(self, mgn: f64) -> Self
[src]
fn top_left_with_margins(self, top: f64, left: f64) -> Self
[src]
fn top_right(self) -> Self
[src]
fn top_right_with_margin(self, mgn: f64) -> Self
[src]
fn top_right_with_margins(self, top: f64, right: f64) -> Self
[src]
fn bottom_left(self) -> Self
[src]
fn bottom_left_with_margin(self, mgn: f64) -> Self
[src]
fn bottom_left_with_margins(self, bottom: f64, left: f64) -> Self
[src]
fn bottom_right(self) -> Self
[src]
fn bottom_right_with_margin(self, mgn: f64) -> Self
[src]
fn bottom_right_with_margins(self, bottom: f64, right: f64) -> Self
[src]
fn mid_top(self) -> Self
[src]
fn mid_top_with_margin(self, mgn: f64) -> Self
[src]
fn mid_bottom(self) -> Self
[src]
fn mid_bottom_with_margin(self, mgn: f64) -> Self
[src]
fn mid_left(self) -> Self
[src]
fn mid_left_with_margin(self, mgn: f64) -> Self
[src]
fn mid_right(self) -> Self
[src]
fn mid_right_with_margin(self, mgn: f64) -> Self
[src]
impl<T> SetParameter for T
fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
T: Parameter<Self>,
impl<T> SetParameter for T
fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
T: Parameter<Self>,
impl<W> Sizeable for W where
W: Widget,
[src]
W: Widget,
fn x_dimension(self, w: Dimension) -> W
[src]
fn y_dimension(self, h: Dimension) -> W
[src]
fn get_x_dimension(&self, ui: &Ui) -> Dimension
[src]
We attempt to retrieve the x
Dimension for the widget via the following:
- Check for specified value at
maybe_x_dimension
- Otherwise, use the default returned by Widget::default_x_dimension.
fn get_y_dimension(&self, ui: &Ui) -> Dimension
[src]
We attempt to retrieve the y
Dimension for the widget via the following:
- Check for specified value at
maybe_y_dimension
- Otherwise, use the default returned by Widget::default_y_dimension.
fn w(self, w: f64) -> Self
[src]
fn h(self, h: f64) -> Self
[src]
fn wh(self, wh: [f64; 2]) -> Self
[src]
fn w_h(self, width: f64, height: f64) -> Self
[src]
fn w_of(self, idx: NodeIndex<u32>) -> Self
[src]
fn padded_w_of(self, idx: NodeIndex<u32>, pad: f64) -> Self
[src]
fn h_of(self, idx: NodeIndex<u32>) -> Self
[src]
fn padded_h_of(self, idx: NodeIndex<u32>, pad: f64) -> Self
[src]
fn wh_of(self, idx: NodeIndex<u32>) -> Self
[src]
fn padded_wh_of(self, idx: NodeIndex<u32>, pad: f64) -> Self
[src]
fn kid_area_w_of(self, idx: NodeIndex<u32>) -> Self
[src]
fn padded_kid_area_w_of(self, idx: NodeIndex<u32>, pad: f64) -> Self
[src]
fn kid_area_h_of(self, idx: NodeIndex<u32>) -> Self
[src]
fn padded_kid_area_h_of(self, idx: NodeIndex<u32>, pad: f64) -> Self
[src]
fn kid_area_wh_of(self, idx: NodeIndex<u32>) -> Self
[src]
fn padded_kid_area_wh_of(self, idx: NodeIndex<u32>, pad: f64) -> Self
[src]
fn get_w(&self, ui: &Ui) -> Option<f64>
[src]
fn get_h(&self, ui: &Ui) -> Option<f64>
[src]
fn get_wh(&self, ui: &Ui) -> Option<[f64; 2]>
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,