Struct Checkbox

pub struct Checkbox { /* private fields */ }

A widget displaying a box which can be cycled through various checked states.

Implementations

impl Checkbox

pub fn new( left: i32, top: i32, text: &str, default: Option<char>, sequence: Option<&[char]>, ) -> Checkbox

Create a new Checkbox widget.

• left - The left-most position of the Checkbox.
• top - The top-most position of the Checkbox.
• text - The label to be displayed with the Checkbox.
• default - The optional default state of the Checkbox. (The default value to be held from the sequence of possible values).
• sequence - The optional sequence of values possible in the Checkbox. (Defaults to and * if not provided).

pub fn get_value(&self) -> char

Get the current value of the Checkbox.

pub fn set_value(&self, value: char)

Set the current value of the Checkbox.

• value - The value to set the Checkbox to. It does not necessarily need to be one specified in sequence during the Checkbox creation.

pub fn set_flags(&self, flags: i32, sense: FlagsSense)

Set flags modifying the Checkbox behavior.

See flags for possible flags.

• flags - A logical ored list of flags.
• sense - The operation used to set the flags (Set, Reset, or Toggle).

Trait Implementations

impl Component for Checkbox

fn co(&self) -> newtComponent

Return newtComponent pointer.

impl Debug for Checkbox

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

Formats the value using the given formatter.

impl Drop for Checkbox

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<Box<dyn Component>> for Checkbox

fn eq(&self, other: &Box<dyn Component>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<ExitReason> for Checkbox

fn eq(&self, other: &ExitReason) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Rhs: Component> PartialEq<Rhs> for Checkbox

fn eq(&self, other: &Rhs) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl WidgetFns for Checkbox

fn takes_focus(&self, value: bool)

Allow the widget to be focused when its parent Form is run.

fn get_position(&self) -> (i32, i32)

Get the position of the widget’s top left corner.

fn get_size(&self) -> (i32, i32)

Get the widget’s width and height.