Struct Button

pub struct Button<MSG> {
    pub text: String,
    pub events: Vec<Attribute<Event, MSG>>,
    /* private fields */
}

Base widget to be used with all upper level ones. It may be used to display a box border around the widget and/or add a text.

Examples

Button::default()
    .text("Button")
    .title_style(Style::default().fg(Color::Red))
    .borders(Borders::LEFT | Borders::RIGHT)
    .border_style(Style::default().fg(Color::White))
    .style(Style::default().bg(Color::Black));

Fields

text: String

Optional text place on the upper left of the block

events: Vec<Attribute<Event, MSG>>

events attached to this block

Implementations

impl<MSG> Button<MSG>

where MSG: 'static,

pub fn new(events: Vec<Attribute<Event, MSG>>, label: &str) -> Self

pub fn label(self, label: &str) -> Self

pub fn area(self, area: Rect) -> Self

pub fn events(self, events: Vec<Attribute<Event, MSG>>) -> Self

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

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

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

pub fn borders(self, flag: Borders) -> Self

pub fn triggers_event(&self, event: &Event) -> Option<&Callback<Event, MSG>>

pub fn inner(&self) -> Rect

Compute the inner area of a block based on its border visibility rules.

Trait Implementations

impl<MSG: Clone> Clone for Button<MSG>

fn clone(&self) -> Button<MSG>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<MSG> Default for Button<MSG>

fn default() -> Self

Returns the “default value” for a type.

impl<MSG> Widget for Button<MSG>

where MSG: 'static,

fn get_area(&self) -> Rect

fn draw(&mut self, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That the only method required to implement a custom widget.

fn background(&self, buf: &mut Buffer, color: Color)

Helper method to quickly set the background of all cells inside the specified area.

fn render<B>(&mut self, f: &mut Frame<'_, B>)

where Self: Sized, B: Backend,

Helper method that can be chained with a widget’s builder methods to render it.

fn top(&self) -> u16

fn bottom(&self) -> u16

fn left(&self) -> u16

fn right(&self) -> u16