pub struct Label { /* private fields */ }Expand description
Label widget for displaying text with optional animation
Implementations§
Source§impl Label
impl Label
pub fn new(text: &str) -> Self
pub fn with_style(self, style: Style) -> Self
pub fn with_align(self, align: TextAlign) -> Self
pub fn with_wrap(self, wrap: bool) -> Self
Sourcepub fn with_animation(self, animation: LabelAnimation) -> Self
pub fn with_animation(self, animation: LabelAnimation) -> Self
Set an animation effect on this label
Sourcepub fn with_spotlight(
self,
highlight_style: Style,
frames_per_char: usize,
scale_amplitude: f32,
) -> Self
pub fn with_spotlight( self, highlight_style: Style, frames_per_char: usize, scale_amplitude: f32, ) -> Self
Convenience: configure a spotlight animation
Sourcepub fn with_wave(self, amplitude: f32, wavelength: f32, speed: f32) -> Self
pub fn with_wave(self, amplitude: f32, wavelength: f32, speed: f32) -> Self
Convenience: configure a wave animation
Sourcepub fn with_fade_in(self, frames_per_char: usize, loop_anim: bool) -> Self
pub fn with_fade_in(self, frames_per_char: usize, loop_anim: bool) -> Self
Convenience: configure a fade-in animation
Sourcepub fn with_typewriter(
self,
frames_per_char: usize,
show_cursor: bool,
loop_anim: bool,
) -> Self
pub fn with_typewriter( self, frames_per_char: usize, show_cursor: bool, loop_anim: bool, ) -> Self
Convenience: configure a typewriter animation
pub fn set_text(&mut self, text: &str)
pub fn text(&self) -> &str
pub fn set_align(&mut self, align: TextAlign)
pub fn set_wrap(&mut self, wrap: bool)
pub fn set_animation(&mut self, animation: Option<LabelAnimation>)
pub fn animation(&self) -> Option<&LabelAnimation>
Trait Implementations§
Source§impl Widget for Label
impl Widget for Label
Source§fn set_bounds(&mut self, bounds: Rect)
fn set_bounds(&mut self, bounds: Rect)
Set widget’s bounds
Source§fn state(&self) -> &WidgetState
fn state(&self) -> &WidgetState
Get widget’s current state
Source§fn state_mut(&mut self) -> &mut WidgetState
fn state_mut(&mut self) -> &mut WidgetState
Get mutable widget state
Source§fn as_any_mut(&mut self) -> &mut dyn Any
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<()>
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<()>
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>
fn handle_event( &mut self, _event: &UIEvent, _ctx: &mut Context, ) -> UIResult<bool>
Handle input events
Source§fn preferred_size(&self, available: Rect) -> Rect
fn preferred_size(&self, available: Rect) -> Rect
Calculate preferred size based on content
Source§fn set_visible(&mut self, visible: bool)
fn set_visible(&mut self, visible: bool)
Set widget visibility
Source§fn set_enabled(&mut self, enabled: bool)
fn set_enabled(&mut self, enabled: bool)
Set widget enabled state
Source§fn set_focused(&mut self, focused: bool)
fn set_focused(&mut self, focused: bool)
Set widget focus
Source§fn mark_dirty(&mut self)
fn mark_dirty(&mut self)
Mark widget as dirty (needs redraw)
Source§fn clear_dirty(&mut self)
fn clear_dirty(&mut self)
Clear dirty flag
Source§fn layout_children(&mut self)
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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