Struct conrod::widget::text_edit::TextEdit
[−]
[src]
pub struct TextEdit<'a> { /* fields omitted */ }
A widget for displaying and mutating multi-line text, given as a String
.
By default the text is wrapped via the first whitespace before the line exceeds the
TextEdit
's width, however a user may change this using the .wrap_by_character
method.
Methods
impl<'a> TextEdit<'a>
[src]
pub fn new(text: &'a str) -> Self
[src]
Construct a TextEdit widget.
pub fn wrap_by_whitespace(self) -> Self
[src]
The TextEdit
will wrap text via the whitespace that precedes the first width-exceeding
character.
This is the default setting.
pub fn wrap_by_character(self) -> Self
[src]
By default, the TextEdit
will wrap text via the whitespace that precedes the first
width-exceeding character.
Calling this method causes the TextEdit
to wrap text at the first exceeding character.
pub fn left_justify(self) -> Self
[src]
Align the text to the left of its bounding Rect's x axis range.
pub fn center_justify(self) -> Self
[src]
Align the text to the middle of its bounding Rect's x axis range.
pub fn right_justify(self) -> Self
[src]
Align the text to the right of its bounding Rect's x axis range.
pub fn align_text_bottom(self) -> Self
[src]
Align the text to the left of its bounding Rect's y axis range.
pub fn align_text_y_middle(self) -> Self
[src]
Align the text to the middle of its bounding Rect's y axis range.
pub fn align_text_top(self) -> Self
[src]
Align the text to the right of its bounding Rect's y axis range.
pub fn align_text_middle(self) -> Self
[src]
Align the text to the middle of its bounding Rect.
pub fn font_id(self, font_id: Id) -> Self
[src]
Specify the font used for displaying the text.
pub fn font_size(self, font_size: FontSize) -> Self
[src]
Build the type's self.$($assignee).+ with the given $Type.
pub fn justify(self, justify: Justify) -> Self
[src]
Build the type's self.$($assignee).+ with the given $Type.
pub fn y_align_text(self, y_align_text: Align) -> Self
[src]
Build the type's self.$($assignee).+ with the given $Type.
pub fn line_wrap(self, line_wrap: Wrap) -> Self
[src]
Build the type's self.$($assignee).+ with the given $Type.
pub fn line_spacing(self, line_spacing: Scalar) -> Self
[src]
Build the type's self.$($assignee).+ with the given $Type.
pub fn restrict_to_height(self, restrict_to_height: bool) -> Self
[src]
Build the type's self.$($assignee).+ with the given $Type.
Trait Implementations
impl<'a> Widget for TextEdit<'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 = Option<String>
The type of event yielded by the widget, returned via the Widget::set
function. Read more
fn init_state(&self, id_gen: Generator) -> Self::State
[src]
Return the initial State of the Widget. Read more
fn style(&self) -> Self::Style
[src]
Return the styling of the widget. Read more
fn default_y_dimension(&self, ui: &Ui) -> Dimension
[src]
The default height of the widget. Read more
fn update(self, args: UpdateArgs<Self>) -> Self::Event
[src]
Update the state of the TextEdit.
fn default_x_position(&self, ui: &Ui) -> Position
[src]
The default Position for the widget along the x axis. Read more
fn default_y_position(&self, ui: &Ui) -> Position
[src]
The default Position for the widget along the y axis. Read more
fn default_x_dimension(&self, ui: &Ui) -> Dimension
[src]
The default width for the Widget. Read more
fn drag_area(
&self,
_dim: Dimensions,
_style: &Self::Style,
_theme: &Theme
) -> Option<Rect>
[src]
&self,
_dim: Dimensions,
_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. Read more
fn kid_area(&self, args: KidAreaArgs<Self>) -> KidArea
[src]
The area on which child widgets will be placed when using the Place
Position
methods.
fn is_over(&self) -> IsOverFn
[src]
Returns either of the following: Read more
fn parent(self, parent_id: Id) -> Self
[src]
Set the parent widget for this Widget by passing the WidgetId of the parent. Read more
fn no_parent(self) -> Self
[src]
Specify that this widget has no parent widgets.
fn place_on_kid_area(self, b: bool) -> Self
[src]
Set whether or not the Widget should be placed on the kid_area. Read more
fn graphics_for(self, id: Id) -> Self
[src]
Indicates that the Widget is used as a non-interactive graphical element for some other widget. Read more
fn floating(self, is_floating: bool) -> Self
[src]
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. Read more
fn crop_kids(self) -> Self
[src]
Indicates that all widgets who are children of this widget should be cropped to the kid_area
of this widget. Read more
fn scroll_kids(self) -> Self
[src]
Makes the widget's KidArea
scrollable. Read more
fn scroll_kids_vertically(self) -> Self
[src]
Makes the widget's KidArea
scrollable. Read more
fn scroll_kids_horizontally(self) -> Self
[src]
Set whether or not the widget's KidArea
is scrollable (the default is false). Read more
fn and<F>(self, build: F) -> Self where
F: FnOnce(Self) -> Self,
[src]
F: FnOnce(Self) -> Self,
A builder method that "lifts" the Widget through the given build
function. Read more
fn and_mut<F>(self, mutate: F) -> Self where
F: FnOnce(&mut Self),
[src]
F: FnOnce(&mut Self),
A builder method that mutates the Widget with the given mutate
function. Read more
fn and_if<F>(self, cond: bool, build: F) -> Self where
F: FnOnce(Self) -> Self,
[src]
F: FnOnce(Self) -> Self,
A method that conditionally builds the Widget with the given build
function. Read more
fn and_then<T, F>(self, maybe: Option<T>, build: F) -> Self where
F: FnOnce(Self, T) -> Self,
[src]
F: FnOnce(Self, T) -> Self,
A method that optionally builds the Widget with the given build
function. Read more
fn set<'a, 'b>(self, id: Id, ui_cell: &'a mut UiCell<'b>) -> Self::Event
[src]
Note: There should be no need to override this method. Read more
impl<'a> Colorable for TextEdit<'a>
[src]
fn color(self, color: Color) -> Self
[src]
Build the type's self.$($assignee).+ with the given $Type.
fn rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
[src]
Set the color of the widget from rgba values.
fn rgb(self, r: f32, g: f32, b: f32) -> Self
[src]
Set the color of the widget from rgb values.
fn hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
[src]
Set the color of the widget from hsla values.
fn hsl(self, h: f32, s: f32, l: f32) -> Self
[src]
Set the color of the widget from hsl values.