Struct druid::widget::Label

pub struct Label<T> { /* fields omitted */ }

A label that displays some text.

Implementations

impl<T: Data> Label<T>

pub fn new(text: impl Into<LabelText<T>>) -> Self

Construct a new Label widget.

use druid::LocalizedString;
use druid::widget::Label;

// Construct a new Label using static string.
let _: Label<u32> = Label::new("Hello world");

// Construct a new Label using localized string.
let text = LocalizedString::new("hello-counter").with_arg("count", |data: &u32, _env| (*data).into());
let _: Label<u32> = Label::new(text);

// Construct a new dynamic Label. Text will be updated when data changes.
let _: Label<u32> = Label::new(|data: &u32, _env: &_| format!("Hello world: {}", data));

pub fn dynamic(text: impl Fn(&T, &Env) -> String + 'static) -> Self

Construct a new dynamic label.

The contents of this label are generated from the data using a closure.

This is provided as a convenience; a closure can also be passed to new, but due to limitations of the implementation of that method, the types in the closure need to be annotated, which is not true for this method.

Examples

The following are equivalent.

use druid::Env;
use druid::widget::Label;
let label1: Label<u32> = Label::new(|data: &u32, _: &Env| format!("total is {}", data));
let label2: Label<u32> = Label::dynamic(|data, _| format!("total is {}", data));

pub fn text_align(self, _align: UnitPoint) -> Self

👎 Deprecated since 0.5.0:

Use an Align widget instead

Set text alignment.

pub fn with_text_color(self, color: impl Into<KeyOrValue<Color>>) -> Self

Builder-style method for setting the text color.

The argument can be either a Color or a Key<Color>.

pub fn with_text_size(self, size: impl Into<KeyOrValue<f64>>) -> Self

Builder-style method for setting the text size.

The argument can be either an f64 or a Key<f64>.

pub fn with_font(self, font: impl Into<KeyOrValue<&'static str>>) -> Self

Builder-style method for setting the font.

The argument can be a &str, String, or Key<&str>.

pub fn set_text(&mut self, text: impl Into<String>)

Set a new text.

Takes an already resolved string as input.

If you're looking for full LabelText support, then you need to create a new Label.

pub fn text(&self) -> &str

Returns this label's current text.

pub fn set_text_color(&mut self, color: impl Into<KeyOrValue<Color>>)

Set the text color.

The argument can be either a Color or a Key<Color>.

pub fn set_text_size(&mut self, size: impl Into<KeyOrValue<f64>>)

Set the text size.

The argument can be either an f64 or a Key<f64>.

pub fn set_font(&mut self, font: impl Into<KeyOrValue<&'static str>>)

Set the font.

The argument can be a &str, String, or Key<&str>.

Trait Implementations

impl<T: Data> Widget<T> for Label<T>

fn event(
    &mut self,
    _ctx: &mut EventCtx,
    _event: &Event,
    _data: &mut T,
    _env: &Env
)

Handle an event.

fn lifecycle(
    &mut self,
    _ctx: &mut LifeCycleCtx,
    event: &LifeCycle,
    data: &T,
    env: &Env
)

Handle a life cycle notification.

fn update(&mut self, ctx: &mut UpdateCtx, old_data: &T, data: &T, env: &Env)

Handle a change of data.

fn layout(
    &mut self,
    ctx: &mut LayoutCtx,
    bc: &BoxConstraints,
    _data: &T,
    env: &Env
) -> Size

Compute layout.

fn paint(&mut self, ctx: &mut PaintCtx, _data: &T, env: &Env)

Paint the widget appearance.