Struct CheckButton

pub struct CheckButton { /* private fields */ }

Implementations

impl CheckButton

A simple check button that manages an internal state which determines if the button is to be checked or not. The actual checking is handled by the user during an event loop.

Examples

use oxide::core::{HorizontalAlign, VerticalAlign, ButtonResult, Widget, Button};
use oxide::{Dialog, CheckButton};

let mut dlg = Dialog::new(60, 10);

let mut b1 = CheckButton::new("Foo", 'f', ButtonResult::Ok);
b1.pack(&dlg, HorizontalAlign::Left, VerticalAlign::Bottom, (1,1));
// Change the initial state of the button to checked
b1.pressed();

dlg.add_button(b1);

// Now switch the state of the button bound to Ok, which unchecks b1
dlg.button_pressed(ButtonResult::Ok);

pub fn new(text: &str, accel: char, result: ButtonResult) -> CheckButton

Constructs a new CheckButton, asking for the text to be displayed by the button, the key to map to, and the result returned when the key is detected.

Examples

use oxide::core::ButtonResult;
use oxide::CheckButton;

let mut b1 = CheckButton::new("Foo", 'f', ButtonResult::Ok);

Trait Implementations

impl Button for CheckButton

fn accel(&self) -> char

Return the char that is acting as the key in the Button

fn result(&self) -> ButtonResult

Return the ButtonResult which would be returned if the key is detected

fn pressed(&mut self)

If a button is to do some special action upon being pressed, then this function will do so. StdButton for example does nothing when pressed, while CheckButton changes it’s ballot

fn state(&self) -> bool

If a button has a state involved, e.g. needs to keep track of a certain event, this function will return the state of the button.

impl Widget for CheckButton

fn draw(&mut self, parent: &mut dyn CellAccessor)

Draws the widget to the valid CellAccessor passed

fn pack( &mut self, parent: &dyn HasSize, halign: HorizontalAlign, valign: VerticalAlign, margin: (usize, usize), )

Aligns the widget with the parent as reference

fn draw_box(&mut self)

Expose the painter trait draw_box for all widgets, which outlines the space enclosed within the widget

fn resize(&mut self, new_size: Size)

Resize the given widget to new dimensions given by Size

fn frame(&self) -> &Frame

Return a reference the renderer, Base in general cases

fn frame_mut(&mut self) -> &mut Frame

Return a mutable reference to the renderer, Base in general cases