Skip to main content

Label

Struct Label 

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

Label widget for displaying text with optional animation

Implementations§

Source§

impl Label

Source

pub fn new(text: &str) -> Self

Source

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

Source

pub fn with_align(self, align: TextAlign) -> Self

Source

pub fn with_wrap(self, wrap: bool) -> Self

Source

pub fn with_animation(self, animation: LabelAnimation) -> Self

Set an animation effect on this label

Source

pub fn with_spotlight( self, highlight_style: Style, frames_per_char: usize, scale_amplitude: f32, ) -> Self

Convenience: configure a spotlight animation

Source

pub fn with_wave(self, amplitude: f32, wavelength: f32, speed: f32) -> Self

Convenience: configure a wave animation

Source

pub fn with_fade_in(self, frames_per_char: usize, loop_anim: bool) -> Self

Convenience: configure a fade-in animation

Source

pub fn with_typewriter( self, frames_per_char: usize, show_cursor: bool, loop_anim: bool, ) -> Self

Convenience: configure a typewriter animation

Source

pub fn set_text(&mut self, text: &str)

Source

pub fn text(&self) -> &str

Source

pub fn set_align(&mut self, align: TextAlign)

Source

pub fn set_wrap(&mut self, wrap: bool)

Source

pub fn set_animation(&mut self, animation: Option<LabelAnimation>)

Source

pub fn animation(&self) -> Option<&LabelAnimation>

Trait Implementations§

Source§

impl Widget for Label

Source§

fn id(&self) -> WidgetId

Get widget’s unique identifier
Source§

fn bounds(&self) -> Rect

Get widget’s current bounds
Source§

fn set_bounds(&mut self, bounds: Rect)

Set widget’s bounds
Source§

fn state(&self) -> &WidgetState

Get widget’s current state
Source§

fn state_mut(&mut self) -> &mut WidgetState

Get mutable widget state
Source§

fn as_any(&self) -> &dyn Any

Get widget as Any for downcasting
Source§

fn as_any_mut(&mut self) -> &mut dyn Any

Get mutable widget as Any for downcasting
Source§

fn update(&mut self, _dt: f32, _ctx: &mut Context) -> UIResult<()>

Update widget logic (called every frame)
Source§

fn render(&self, buffer: &mut Buffer, _ctx: &Context) -> UIResult<()>

Render the widget to a buffer
Source§

fn handle_event( &mut self, _event: &UIEvent, _ctx: &mut Context, ) -> UIResult<bool>

Handle input events
Source§

fn preferred_size(&self, available: Rect) -> Rect

Calculate preferred size based on content
Source§

fn hit_test(&self, x: u16, y: u16) -> bool

Check if point is inside widget bounds
Source§

fn set_visible(&mut self, visible: bool)

Set widget visibility
Source§

fn set_enabled(&mut self, enabled: bool)

Set widget enabled state
Source§

fn set_focused(&mut self, focused: bool)

Set widget focus
Source§

fn mark_dirty(&mut self)

Mark widget as dirty (needs redraw)
Source§

fn clear_dirty(&mut self)

Clear dirty flag
Source§

fn is_dirty(&self) -> bool

Check if widget is dirty
Source§

fn layout_children(&mut self)

Layout children if this widget is a container Default implementation does nothing, containers should override this

Auto Trait Implementations§

§

impl Freeze for Label

§

impl RefUnwindSafe for Label

§

impl Send for Label

§

impl Sync for Label

§

impl Unpin for Label

§

impl UnsafeUnpin for Label

§

impl UnwindSafe 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<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> UnsafeAny for T
where T: Any,