Struct conrod::Text

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

Displays some given text centred 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 Align.

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>

fn new(text: &'a str) -> Self

Build a new Text widget.

fn font_size(self, size: FontSize) -> Self

Build the Text with the given font size.

fn no_line_wrap(self) -> Self

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

fn wrap_by_word(self) -> Self

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

fn wrap_by_character(self) -> Self

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

fn with_style(self, style: Style) -> Self

Build the Text with the given Style.

fn align_text_left(self) -> Self

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

fn align_text_middle(self) -> Self

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

fn align_text_right(self) -> Self

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

fn line_spacing(self, height: Scalar) -> Self

The height of the space used between consecutive lines.

Trait Implementations

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.

fn common(&self) -> &CommonBuilder

Return a reference to a CommonBuilder struct owned by the Widget. This method allows us to do a blanket impl of Positionable and Sizeable for T: Widget.

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

Return a mutable reference to a CommonBuilder struct owned by the Widget. This method allows us to do a blanket impl of Positionable and Sizeable for T: Widget.

fn unique_kind(&self) -> &'static str

Return the kind of the widget as a &'static str.

fn init_state(&self) -> State

Return the initial State of the Widget.

fn style(&self) -> Style

Return the styling of the widget.

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

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

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

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

fn update<C: CharacterCache>(self, args: UpdateArgs<Self, C>)

Update the state of the Text.

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

The default Position for the widget along the x axis.

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

The default Position for the widget along the y axis.

fn drag_area(&self, _dim: Dimensions, _style: &Self::Style, _theme: &Theme) -> Option<Rect>

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

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

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

fn parent<I: Into<Index>>(self, parent_idx: I) -> 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<I: Into<Index>>(self, idx: I) -> 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 scroll_kids(self) -> Self

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

fn scroll_kids_vertically(self) -> Self

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

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 the Widget with the given build function.

fn set<I, U>(self, idx: I, ui: &mut U) where I: Into<Index>, U: UiRefMut

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

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

fn color(self, color: Color) -> Self

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.