Skip to main content

Label

Struct Label 

Source
pub struct Label { /* private fields */ }

Implementations§

Source§

impl Label

Source

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

Source

pub fn single_line(self, single_line: bool) -> Self

Keep the label on one line, clipping overflow while retaining its full semantics.

Source

pub fn text_when<F>(self, reader: F) -> Self
where F: Fn() -> String + 'static,

Source

pub fn text_from<O>(self, source: O) -> Self
where O: Observable<String> + 'static,

Bind label text to an observable value.

Changes automatically invalidate text measurement, paint, and semantics for this retained label instance.

Source

pub fn semantic_name(self, name: impl Into<String>) -> Self

Source

pub fn selectable(self, selection_scope: SelectionScope) -> Self

Source

pub fn clipboard_behavior(self, behavior: SelectionClipboardBehavior) -> Self

Source

pub fn copy_to_clipboard(self, enabled: bool) -> Self

Source

pub fn selection_scope(&self) -> Option<&SelectionScope>

Source

pub fn theme(self, theme: DefaultTheme) -> Self

Take the default text style from theme. A style, color, font size, or line height set on the label wins over it, whichever came first.

Source

pub fn theme_when<F>(self, theme: F) -> Self
where F: Fn() -> DefaultTheme + 'static,

Self::theme, reading the theme each time the label lays out.

Source

pub fn text(&self) -> &str

Source

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

Source

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

Source

pub fn color_when<F>(self, color: F) -> Self
where F: Fn() -> Color + 'static,

Source

pub fn font_size(self, font_size: f32) -> Self

Source

pub fn line_height(self, line_height: f32) -> Self

Source

pub fn text_style(self, text_style: TextStyle) -> Self

Draw the label in text_style, in place of the theme’s. A color, font size, or line height set on the label still layers over it.

Source

pub fn text_style_when<F>(self, text_style: F) -> Self
where F: Fn() -> TextStyle + 'static,

Self::text_style, resolving the style each time the label is measured or painted.

Trait Implementations§

Source§

impl Widget for Label

Source§

fn supports_output_reuse(&self) -> bool

Opt into retaining paint and semantics between targeted invalidations. Output must depend only on widget state, context, and observed sources; changes must invalidate the widget. Untracked readers and callbacks with side effects should keep the default. An opaque descendant also prevents caching its ancestors. Explicit subtree/window requests always rerun them. A source observed only in paint or semantics invalidates that callback, not its descendants. Mutating child state requires a child/subtree request.
Source§

fn event(&mut self, ctx: &mut EventCtx, event: &Event)

Source§

fn command(&mut self, ctx: &mut EventCtx, command: &Command<'_>)

Receive a typed command addressed directly to this widget. Commands are target-only and do not capture or bubble through the widget tree.
Source§

fn intrinsic_size( &mut self, ctx: &mut MeasureCtx, axis: Axis, available_cross: f32, ) -> IntrinsicSize

Report the smallest and preferred extent along one axis. Read more
Source§

fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size

Source§

fn paint(&self, ctx: &mut PaintCtx)

Source§

fn semantics(&self, ctx: &mut SemanticsCtx)

Source§

fn accepts_focus(&self) -> bool

Source§

fn focus_changed(&mut self, ctx: &mut EventCtx, _focused: bool)

Source§

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

Source§

fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)

Publish widget-specific state for an inspector snapshot. Read more
Source§

fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size

Compute a provisional size. Containers can override this to query child sizes without committing their final layouts. The default preserves existing custom widgets by delegating to measure; it may mutate state. Child measure calls still commit state. Use child size probes explicitly when only their scalar results are needed. Results must match measure for the same content and constraints. A final measure is still required before arrangement after a probe miss.
Source§

fn measure_axis( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, axis: Axis, ) -> f32

Query one component of measure_size under exactly the same constraints. Overrides may avoid computing the other component, but must return the same extent. Like size probes, this does not replace final measurement.
Source§

fn arrange(&mut self, _ctx: &mut ArrangeCtx, _bounds: Rect)

Source§

fn layer_options(&self) -> LayerOptions

Source§

fn layer_properties(&self) -> LayerProperties

Source§

fn layer_properties_at(&self, frame_time: f64) -> LayerProperties

Layer properties for the frame shown at frame_time. Override this instead of Widget::layer_properties when they come from Motion values; the runtime refreshes them without repainting when the motion invalidates Transform or Effect.
Source§

fn stack_host_options(&self) -> Option<StackHostOptions>

Source§

fn stack_surface_options(&self) -> Option<StackSurfaceOptions>

Source§

fn overlay_options(&self) -> Option<OverlayOptions>

Describe this widget as the logical owner of a presented overlay. Read more
Source§

fn hit_test_self(&self) -> bool

Whether points inside this widget that none of its children take hit the widget itself. Containers laid over other content, like a layer of floating views, return false so those points reach what is behind them.
Source§

fn visit_children(&self, _visitor: &mut dyn WidgetPodVisitor)

Visit this widget’s logical children. Read more
Source§

fn visit_children_mut(&mut self, _visitor: &mut dyn WidgetPodMutVisitor)

Mutably visit this widget’s logical children. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Label

§

impl !Send for Label

§

impl !Sync for Label

§

impl !UnwindSafe for Label

§

impl Forget for Label

§

impl Freeze for Label

§

impl Move for Label

§

impl Unpin for Label

§

impl UnsafeUnpin for Label

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.