Struct nannou::ui::widget::primitive::text::Text

pub struct Text<'a> {
    pub common: CommonBuilder,
    pub text: &'a str,
    pub style: Style,
}

Displays some given text centered within a rectangular area.

By default, the rectangular dimensions are fit to the area occuppied by the text.

If some horizontal dimension is given, the text will automatically wrap to the width and align in accordance with the produced Alignment.

Fields

common: CommonBuilder

Data necessary and common for all widget builder types.

text: &'a str

The text to be drawn by the Text.

style: Style

Unique styling for the Text.

Methods

impl<'a> Text<'a>

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

Build a new Text widget.

pub fn no_line_wrap(self) -> Text<'a>

Specify that the Text should not wrap lines around the width.

pub fn wrap_by_word(self) -> Text<'a>

Line wrap the Text at the beginning of the first word that exceeds the width.

pub fn wrap_by_character(self) -> Text<'a>

Line wrap the Text at the beginning of the first character that exceeds the width.

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

A method for specifying the Font used for displaying the Text.

pub fn with_style(self, style: Style) -> Text<'a>

Build the Text with the given Style.

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

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

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

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

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

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

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

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

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

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

pub fn line_spacing(self, line_spacing: f64) -> Text<'a>

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

Trait Implementations

impl<'a> Clone for Text<'a>

fn clone(&self) -> Text<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Colorable for Text<'a>

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

Set the color of the widget.

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 Text<'a>

fn common(&self) -> &CommonBuilder

Borrows the CommonBuilder field.

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

Mutably borrows the CommonBuilder field.

impl<'a> Debug for Text<'a>

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> Widget for Text<'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 = ()

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

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

Return the initial State of the Widget.

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

Return the styling of the widget.

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

If no specific width was given, we'll use the width of the widest line as a default.

The Font used by the Text is retrieved in order to determine the width of each line. If the font used by the Text cannot be found, a dimension of Absolute(0.0) is returned.

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

If no specific height was given, we'll use the total height of the text as a default.

The Font used by the Text is retrieved in order to determine the width of each line. If the font used by the Text cannot be found, a dimension of Absolute(0.0) is returned.

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

Update the state of the Text.

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 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.