Struct kas_widgets::CheckButton

pub struct CheckButton { /* private fields */ }

A check button with label

See also CheckBox which excludes the label.

Implementations

impl CheckButton

pub fn new<T: Into<AccelString>>(label: T) -> Self

Construct a check button with a given label

CheckButton labels are optional; if no label is desired, use an empty string or use CheckBox instead.

pub fn on_toggle<F>(self, f: F) -> CheckButtonwhere
    F: Fn(&mut EventMgr<'_>, bool) + 'static,

Set event handler f

When the check button is set or unset, the closure f is called.

pub fn new_on<T: Into<AccelString>, F>(label: T, f: F) -> Selfwhere
    F: Fn(&mut EventMgr<'_>, bool) + 'static,

Construct a check button with a given label and event handler f

CheckButton labels are optional; if no label is desired, use an empty string or use CheckBox instead.

When the check button is set or unset, the closure f is called.

pub fn with_state(self, state: bool) -> Self

Set the initial state of the check button.

pub fn editable(self, editable: bool) -> Self

Set whether this widget is editable (inline)

pub fn is_editable(&self) -> bool

Get whether this widget is editable

pub fn set_editable(&mut self, editable: bool)

Set whether this widget is editable

Trait Implementations

impl AutoLayout for CheckButton

fn size_rules(&mut self, size_mgr: SizeMgr<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, mgr: &mut ConfigMgr<'_>, rect: Rect)

Set size and position

fn find_id(&mut self, coord: Coord) -> Option<WidgetId>

Translate a coordinate to a WidgetId

fn draw(&mut self, draw: DrawMgr<'_>)

Draw a widget and its children

impl Clone for CheckButton

fn clone(&self) -> CheckButton

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CheckButton

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

Formats the value using the given formatter.

impl Default for CheckButton

fn default() -> CheckButton

Returns the “default value” for a type.

impl HasBool for CheckButton

fn get_bool(&self) -> bool

Get the widget’s state

fn set_bool(&mut self, state: bool) -> TkAction

Set the widget’s state

impl Layout for CheckButton

fn set_rect(&mut self, mgr: &mut ConfigMgr<'_>, rect: Rect)

Set size and position

fn find_id(&mut self, coord: Coord) -> Option<WidgetId>

Translate a coordinate to a WidgetId

fn size_rules(&mut self, size_mgr: SizeMgr<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn draw(&mut self, draw: DrawMgr<'_>)

Draw a widget and its children

impl Widget for CheckButton

fn configure(&mut self, mgr: &mut ConfigMgr<'_>)

Configure widget

fn pre_configure(&mut self, _: &mut ConfigMgr<'_>, id: WidgetId)

Pre-configuration

fn nav_next(
    &mut self,
    _: &mut ConfigMgr<'_>,
    reverse: bool,
    from: Option<usize>
) -> Option<usize>

Navigation in spatial order

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

fn translation(&self) -> Offset

Get translation of children relative to this widget

fn handle_event(&mut self, mgr: &mut EventMgr<'_>, event: Event) -> Response

Handle an event sent to this widget

fn steal_event(
    &mut self,
    mgr: &mut EventMgr<'_>,
    id: &WidgetId,
    event: &Event
) -> Response

Potentially steal an event before it reaches a child

fn handle_unused(
    &mut self,
    mgr: &mut EventMgr<'_>,
    index: usize,
    event: Event
) -> Response

Handle an event sent to child index but left unhandled

fn handle_message(&mut self, mgr: &mut EventMgr<'_>, index: usize)

Handler for messages from children/descendants

fn handle_scroll(&mut self, mgr: &mut EventMgr<'_>, scroll: Scroll)

Handler for scrolling

impl WidgetChildren for CheckButton

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, _index: usize) -> Option<&dyn Widget>

Get a reference to a child widget by index, or None if the index is out of bounds.

fn get_child_mut(&mut self, _index: usize) -> Option<&mut dyn Widget>

Mutable variant of get

fn find_child_index(&self, id: &WidgetId) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn make_child_id(&mut self, index: usize) -> WidgetId

Make an identifier for a child

impl WidgetCore for CheckButton

fn id_ref(&self) -> &WidgetId

Get the widget’s identifier

fn rect(&self) -> Rect

Get the widget’s region, relative to its parent.

fn widget_name(&self) -> &'static str

Get the name of the widget struct

fn as_widget(&self) -> &dyn Widget

Erase type

fn as_widget_mut(&mut self) -> &mut dyn Widget

Erase type