Struct glerminal::menu_systems::Checkbox

pub struct Checkbox {
    pub fg_color_unfocused: [f32; 4],
    pub bg_color_unfocused: [f32; 4],
    pub fg_color_focused: [f32; 4],
    pub bg_color_focused: [f32; 4],
    pub button_press_inputs: Vec<VirtualKeyCode>,
    pub mouse_button_press_inputs: Vec<MouseButton>,
    // some fields omitted
}

Represents a Checkbox that can be checked or unchecked, and it's checked-status can be get with is_checked.

See CheckboxGroup to limit how checkboxes can be checked together.

For example:

use glerminal::menu_systems::Checkbox;

Checkbox::new("Generate world: ")
    .with_prefix("<")
    .with_suffix(">")
    .with_checked_text("O");

// Creates a checbox that looks unchecked:
// Generate world: < >
// And checked:
// Generate world: <O>

Fields

fg_color_unfocused: [f32; 4]

Foreground color for when the checkbox is not focused

bg_color_unfocused: [f32; 4]

Background color for when the checkbox is not focused

fg_color_focused: [f32; 4]

Foreground color for when the checkbox is focused

bg_color_focused: [f32; 4]

Background color for when the checkbox is focused

button_press_inputs: Vec<VirtualKeyCode>

The keyboard inputs that trigger was_just_pressed

mouse_button_press_inputs: Vec<MouseButton>

The mouse inputs that trigger was_just_pressed

Methods

impl Checkbox

pub fn new<T: Into<String>>(text: T) -> Checkbox

Intiailizes a Checkbox with the given text and max width

pub fn with_pos(self, pos: (u32, u32)) -> Checkbox

Sets the initial position

pub fn with_focused(self, focused: bool) -> Checkbox

Set whether the checkbox is initially focused or not

pub fn with_button_press_inputs(self, buttons: Vec<VirtualKeyCode>) -> Checkbox

Set the buttons which trigger was_just_pressed

pub fn with_mouse_button_press_inputs(     self,     buttons: Vec<MouseButton> ) -> Checkbox

Set the mouse buttons which trigger was_just_pressed

pub fn was_just_pressed(&self) -> bool

Returns whether buttons from mouse_button_press_inputs or button_press_inputs were pressed just now.

pub fn with_unfocused_colors(self, colors: ([f32; 4], [f32; 4])) -> Checkbox

Set the initial colors when it is unfocused

pub fn with_focused_colors(self, colors: ([f32; 4], [f32; 4])) -> Checkbox

Set the initial colors when it is focused

pub fn set_unfocused_colors(&mut self, colors: ([f32; 4], [f32; 4]))

Set the colors when it is unfocused

pub fn set_focused_colors(&mut self, colors: ([f32; 4], [f32; 4]))

Set the colors when it is focused

pub fn with_text<T: Into<String>>(self, text: T) -> Checkbox

Sets the initial text of the Checkbox

pub fn with_prefix<T: Into<String>>(self, prefix: T) -> Checkbox

Sets the initial prefix of the Checkbox

pub fn with_suffix<T: Into<String>>(self, suffix: T) -> Checkbox

Sets the initial suffix of the Checkbox

pub fn with_checked_text<T: Into<String>>(self, checked_text: T) -> Checkbox

Sets the initial checked-text (text shown in between prefix and suffix) of the Checkbox

pub fn with_checked(self, checked: bool) -> Checkbox

Set whether the checkbox is initially checked or not

pub fn set_text<T: Into<String>>(&mut self, text: T)

Sets the text of the Checkbox

pub fn set_prefix<T: Into<String>>(&mut self, prefix: T)

Sets the prefix of the Checkbox

pub fn set_suffix<T: Into<String>>(&mut self, suffix: T)

Sets the suffix of the Checkbox

pub fn set_checked_text<T: Into<String>>(self, checked_text: T)

Sets the checked-text (text shown in between prefix and suffix) of the Checkbox

pub fn get_text(&self) -> String

Return the current text of the Checkbox

pub fn get_prefix(&self) -> String

Return the current prefix of the Checkbox

pub fn get_suffix(&self) -> String

Return the current suffix of the Checkbox

pub fn set_checked(&mut self, checked: bool)

Sets the checked-status for this checkbox.

pub fn is_checked(&self) -> bool

Returns whether this checkbox is checked.

Trait Implementations

impl InterfaceItem for Checkbox

fn get_base(&self) -> &InterfaceItemBase

Get the InterfaceItemBase

fn get_mut_base(&mut self) -> &mut InterfaceItemBase

Get the InterfaceItemBase as mutable

fn get_total_width(&self) -> u32

Get the width this InterfaceItem can take up

fn get_total_height(&self) -> u32

Get the height this InterfaceItem can take up

fn draw(&mut self, text_buffer: &mut TextBuffer)

Draw the InterfaceItem

fn handle_events(&mut self, events: &Events) -> bool

Handle events for this InterfaceItem.

fn update(&mut self, _: f32)

Update this InterfaceItem; delta is given in seconds. (see Terminal.delta_time())

impl Clone for Checkbox

fn clone(&self) -> Checkbox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Checkbox

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.