Button

Struct Button 

Source
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:

  1. Normal - Default appearance with standard border and background
  2. Hover - Enhanced appearance when mouse/pointer is over the button
  3. 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>

Source

pub fn new(label: &'a str) -> Button<'a>

Creates a new button with the given text label.

§Arguments
  • label - The text to display on the button
§Returns

A new Button instance with the specified label and no smartstate

Source

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§

Source§

impl Widget for Button<'_>

Source§

fn draw<DRAW: DrawTarget<Color = COL>, COL: PixelColor>( &mut self, ui: &mut Ui<'_, DRAW, COL>, ) -> GuiResult<Response>

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
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<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.