pub struct Button<'a> { /* private fields */ }Expand description
§Button Widget
A clickable button widget that displays text and responds to user interaction.
Buttons are one of the most fundamental widgets in Kolibri. They provide a simple way to trigger actions in response to user input. Buttons can be created with just a text label and optionally support smartstate-based incremental redrawing for better performance.
§Features
- Text label with customizable font and colors
- Visual feedback for different interaction states (normal, hover, pressed)
- Optional smartstate support for incremental redrawing
- Automatic sizing based on text content and style settings
§Example
// Create a basic button
if ui.add(Button::new("Click me!")).clicked() {
// Handle click
}
// Create a button with smartstate for incremental redrawing
let mut smartstateProvider = SmartstateProvider::<20>::new();
if ui.add(Button::new("Efficient!").smartstate(smartstateProvider.nxt())).clicked() {
// Handle click with improved performance
}
// Create a button in a horizontal layout
if ui.add_horizontal(Button::new("-")).clicked() {
// Handle click in horizontal layout
}§Visual States
Buttons have three visual states that provide user feedback:
- Normal - Default appearance with standard border and background
- Hover - Enhanced appearance when mouse/pointer is over the button
- Pressed - Highlighted appearance when clicked/pressed
§Styling
Buttons follow the [UI]’s current style settings including:
- Border colors and widths (normal and highlighted)
- Background colors (normal, highlighted, and pressed)
- Text color and font
- Padding and spacing
Implementations§
Source§impl<'a> Button<'a>
impl<'a> Button<'a>
Sourcepub fn smartstate(self, smartstate: &'a mut Smartstate) -> Self
pub fn smartstate(self, smartstate: &'a mut Smartstate) -> Self
Adds smartstate support to the button for incremental redrawing.
When a smartstate is provided, the button will only redraw when its visual state changes, significantly improving performance especially on slower displays.
§Arguments
smartstate- The smartstate to use for tracking the button’s state
§Returns
Self with smartstate configured
Trait Implementations§
Auto Trait Implementations§
impl<'a> Freeze for Button<'a>
impl<'a> RefUnwindSafe for Button<'a>
impl<'a> Send for Button<'a>
impl<'a> Sync for Button<'a>
impl<'a> Unpin for Button<'a>
impl<'a> !UnwindSafe for Button<'a>
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<T> CheckedAs for T
impl<T> CheckedAs for T
Source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.
Source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
Source§fn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.
Source§impl<T> OverflowingAs for T
impl<T> OverflowingAs for T
Source§fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
Source§fn overflowing_cast_from(src: Src) -> (Dst, bool)
fn overflowing_cast_from(src: Src) -> (Dst, bool)
Casts the value.
Source§impl<T> SaturatingAs for T
impl<T> SaturatingAs for T
Source§fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
Source§fn saturating_cast_from(src: Src) -> Dst
fn saturating_cast_from(src: Src) -> Dst
Casts the value.
Source§impl<T> UnwrappedAs for T
impl<T> UnwrappedAs for T
Source§fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
Casts the value.
Source§impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
Source§fn unwrapped_cast_from(src: Src) -> Dst
fn unwrapped_cast_from(src: Src) -> Dst
Casts the value.
Source§impl<T> WrappingAs for T
impl<T> WrappingAs for T
Source§fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
Source§fn wrapping_cast_from(src: Src) -> Dst
fn wrapping_cast_from(src: Src) -> Dst
Casts the value.