Struct cursive::views::Button

pub struct Button { /* fields omitted */ }

Simple text label with a callback when is pressed.

A button shows its content in a single line and has a fixed size.

Examples

use cursive_core::views::Button;

let quit_button = Button::new("Quit", |s| s.quit());

Implementations

impl Button

pub fn disable(&mut self)

Disables this view.

A disabled view cannot be selected.

pub fn disabled(self) -> Button

Disables this view.

Chainable variant.

pub fn enable(&mut self)

Re-enables this view.

pub fn set_enabled(&mut self, enabled: bool)

Enable or disable this view.

pub fn with_enabled(self, is_enabled: bool) -> Button

Enable or disable this view.

Chainable variant.

pub fn is_enabled(&self) -> bool

Returns true if this view is enabled.

pub fn new<F, S>(label: S, cb: F) -> Button where
    F: 'static + Fn(&mut Cursive),
    S: Into<String>, 

Creates a new button with the given content and callback.

pub fn new_raw<F, S>(label: S, cb: F) -> Button where
    F: 'static + Fn(&mut Cursive),
    S: Into<String>, 

Creates a new button without angle brackets.

Examples

use cursive_core::views::Button;

let button = Button::new_raw("[ Quit ]", |s| s.quit());

pub fn set_callback<F>(&mut self, cb: F) where
    F: Fn(&mut Cursive) + 'static, 

Sets the function to be called when the button is pressed.

Replaces the previous callback.

pub fn label(&self) -> &str

Returns the label for this button.

Includes brackets.

Examples

let button = Button::new("Quit", |s| s.quit());
assert_eq!(button.label(), "<Quit>");

pub fn set_label<S>(&mut self, label: S) where
    S: Into<String>, 

Sets the label to the given value.

This will include brackets.

Examples

use cursive_core::views::Button;

let mut button = Button::new("Quit", |s| s.quit());
button.set_label("Escape");

pub fn set_label_raw<S>(&mut self, label: S) where
    S: Into<String>, 

Sets the label exactly to the given value.

This will not include brackets.

Trait Implementations

impl View for Button

pub fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus.

pub fn layout(&mut self, size: XY<usize>)

Called once the size for this view has been decided.

pub fn required_size(&mut self, XY<usize>) -> XY<usize>

Returns the minimum size the view requires with the given restrictions.

pub fn on_event(&mut self, event: Event) -> EventResult

Called when an event is received (key press, mouse event, ...).

pub fn take_focus(&mut self, Direction) -> bool

This view is offered focus. Will it take it?

pub fn important_area(&self, view_size: XY<usize>) -> Rect

What part of the view is important and should be visible?

pub fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout().

pub fn call_on_any(
    &mut self,
    &Selector<'_>,
    &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)
)

Runs a closure on the view identified by the given selector.

pub fn focus_view(&mut self, &Selector<'_>) -> Result<(), ()>

Moves the focus to the view identified by the given selector.

pub fn type_name(&self) -> &'static str

Returns the type of this view.