Struct kas::widget::CheckBox

pub struct CheckBox<M: 'static> { /* fields omitted */ }

A checkable box with optional label

Methods

impl<M: 'static> CheckBox<M>

pub fn new_on<T: Into<AccelString>, F>(f: F, label: T) -> Self where
    F: Fn(bool) -> M + 'static, 

Construct a checkbox with a given label which calls f when toggled.

This is a shortcut for CheckBox::new(label).on_toggle(f).

Checkbox labels are optional; if no label is desired, use an empty string.

The closure f is called with the new state of the checkbox when toggled, and the result of f is returned from the event handler.

impl CheckBox<VoidMsg>

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

Construct a checkbox with a given label.

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

pub fn on_toggle<M, F>(self, f: F) -> CheckBox<M> where
    F: Fn(bool) -> M + 'static, 

Set the event handler to be called on toggle.

The closure f is called with the new state of the checkbox when toggled, and the result of f is returned from the event handler.

impl<M: 'static> CheckBox<M>

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

Set the initial state of the checkbox.

Trait Implementations

impl<M: Clone + 'static> Clone for CheckBox<M>

fn clone(&self) -> CheckBox<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: 'static> Debug for CheckBox<M>

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

Formats the value using the given formatter.

impl<M: Default + 'static> Default for CheckBox<M>

fn default() -> CheckBox<M>

Returns the "default value" for a type.

impl<M: 'static> Handler for CheckBox<M> where
    M: From<VoidMsg>, 

type Msg = M

Type of message returned by this widget

fn activation_via_press(&self) -> bool

Generic handler: translate presses to activations

fn handle(&mut self, _: &mut Manager, event: Event) -> Response<Self::Msg>

Handle an event and return a user-defined message

impl<M: 'static> HasBool for CheckBox<M>

fn get_bool(&self) -> bool

Get the widget's state

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

Set the widget's state

impl<M: 'static> Layout for CheckBox<M>

fn size_rules(
    &mut self,
    size_handle: &mut dyn SizeHandle,
    axis: AxisInfo
) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, rect: Rect, align: AlignHints)

Apply a given rect to self

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

Find a widget by coordinate

fn draw(
    &self,
    draw_handle: &mut dyn DrawHandle,
    mgr: &ManagerState,
    disabled: bool
)

Draw a widget and its children

fn translation(&self, _child_index: usize) -> Coord

Get translation of a child

fn spatial_range(&self) -> (usize, usize)

Iterate through children in spatial order

impl<M: 'static> LayoutData for CheckBox<M>

type Data = FixedRowStorage<[SizeRules; 3], [u32; 2]>

type Solver = RowSolver<Self::Data>

type Setter = RowSetter<Right, [u32; 2], Self::Data>

impl<M: 'static> SendEvent for CheckBox<M> where
    M: From<VoidMsg>, 

fn send(
    &mut self,
    mgr: &mut Manager,
    id: WidgetId,
    event: Event
) -> Response<Self::Msg>

Send an event

impl<M: 'static> Widget for CheckBox<M> where
    M: From<VoidMsg>, 

impl<M: 'static> WidgetChildren for CheckBox<M>

fn len(&self) -> usize

Get the number of child widgets

fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

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

fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

Mutable variant of get

fn is_ancestor_of(&self, id: WidgetId) -> bool

Check whether id is a descendant

fn find(&self, id: WidgetId) -> Option<&dyn WidgetConfig>

Find a child widget by identifier

fn find_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig>

Find a child widget by identifier

fn walk(&self, f: &mut dyn FnMut(&dyn WidgetConfig))

Walk through all widgets, calling f once on each.

fn walk_mut(&mut self, f: &mut dyn FnMut(&mut dyn WidgetConfig))

Walk through all widgets, calling f once on each.

impl<M: 'static> WidgetConfig for CheckBox<M>

fn configure(&mut self, mgr: &mut Manager)

Configure widget

fn configure_recurse<'a, 'b>(&mut self, cmgr: ConfigureManager<'a, 'b>)

Configure self and children

fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

impl<M: 'static> WidgetCore for CheckBox<M>

fn as_any(&self) -> &dyn Any

Get self as type Any

fn as_any_mut(&mut self) -> &mut dyn Any

Get self as type Any (mutable)

fn core_data(&self) -> &CoreData

Get direct access to the CoreData providing property storage.

fn core_data_mut(&mut self) -> &mut CoreData

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

Get the name of the widget struct

fn as_widget(&self) -> &dyn WidgetConfig

Erase type

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

Erase type

fn id(&self) -> WidgetId

Get the widget's numeric identifier

fn is_disabled(&self) -> bool

Get whether the widget is disabled

fn set_disabled(&mut self, disabled: bool) -> TkAction

Get the disabled state of a widget

fn rect(&self) -> Rect

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

fn input_state(&self, mgr: &ManagerState, disabled: bool) -> InputState

Construct InputState