Struct kas_widgets::CheckButton
source · pub struct CheckButton<A> { /* private fields */ }
Expand description
A check button with label
This is a CheckBox
with a label.
Implementations§
source§impl<A> CheckButton<A>
impl<A> CheckButton<A>
sourcepub fn new(
label: impl Into<AccessString>,
state_fn: impl Fn(&ConfigCx<'_>, &A) -> bool + 'static
) -> Self
pub fn new( label: impl Into<AccessString>, state_fn: impl Fn(&ConfigCx<'_>, &A) -> bool + 'static ) -> Self
Construct a check button with the given label
label
is displayed to the left or right (according to text direction)state_fn
extracts the current state from input data
sourcepub fn with(self, f: impl Fn(&mut EventCx<'_>, &A, bool) + 'static) -> Self
pub fn with(self, f: impl Fn(&mut EventCx<'_>, &A, bool) + 'static) -> Self
Call the handler f
on toggle
sourcepub fn with_msg<M>(self, f: impl Fn(bool) -> M + 'static) -> Selfwhere
M: Debug + 'static,
pub fn with_msg<M>(self, f: impl Fn(bool) -> M + 'static) -> Selfwhere
M: Debug + 'static,
Send the message generated by f
on toggle
sourcepub fn new_msg<M: Debug + 'static>(
label: impl Into<AccessString>,
state_fn: impl Fn(&ConfigCx<'_>, &A) -> bool + 'static,
msg_fn: impl Fn(bool) -> M + 'static
) -> Self
pub fn new_msg<M: Debug + 'static>( label: impl Into<AccessString>, state_fn: impl Fn(&ConfigCx<'_>, &A) -> bool + 'static, msg_fn: impl Fn(bool) -> M + 'static ) -> Self
Construct a check button with the given label
and msg_fn
label
is displayed to the left or right (according to text direction)state_fn
extracts the current state from input data- A message generated by
msg_fn
is emitted when toggled
sourcepub fn is_editable(&self) -> bool
pub fn is_editable(&self) -> bool
Get whether this widget is editable
sourcepub fn set_editable(&mut self, editable: bool)
pub fn set_editable(&mut self, editable: bool)
Set whether this widget is editable
Trait Implementations§
source§impl<A> AutoLayout for CheckButton<A>
impl<A> AutoLayout for CheckButton<A>
source§impl<A> Events for CheckButton<A>
impl<A> Events for CheckButton<A>
source§fn handle_messages(&mut self, cx: &mut EventCx<'_>, data: &Self::Data)
fn handle_messages(&mut self, cx: &mut EventCx<'_>, data: &Self::Data)
Handler for messages from children/descendants Read more
source§fn steal_event(
&mut self,
_: &mut EventCx<'_>,
_: &Self::Data,
_: &Id,
_: &Event
) -> IsUsed
fn steal_event( &mut self, _: &mut EventCx<'_>, _: &Self::Data, _: &Id, _: &Event ) -> IsUsed
Potentially steal an event before it reaches a child Read more
source§fn configure_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)
fn configure_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)
Configure children Read more
source§fn update(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)
fn update(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)
Update self using input data Read more
source§fn update_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)
fn update_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)
Update children Read more
Is this widget navigable via Tab key? Read more
source§impl<A> Layout for CheckButton<A>
impl<A> Layout for CheckButton<A>
source§fn widget_name(&self) -> &'static str
fn widget_name(&self) -> &'static str
Get the name of the widget struct Read more
source§fn num_children(&self) -> usize
fn num_children(&self) -> usize
Get the number of child widgets Read more
source§fn get_child(&self, index: usize) -> Option<&dyn Layout>
fn get_child(&self, index: usize) -> Option<&dyn Layout>
Access a child as a
dyn Layout
Read moresource§fn size_rules(&mut self, sizer: SizeCx<'_>, axis: AxisInfo) -> SizeRules
fn size_rules(&mut self, sizer: SizeCx<'_>, axis: AxisInfo) -> SizeRules
Get size rules for the given axis Read more
Navigation in spatial order Read more
source§fn find_child_index(&self, id: &Id) -> Option<usize>
fn find_child_index(&self, id: &Id) -> Option<usize>
Find the child which is an ancestor of this
id
, if any Read moresource§fn translation(&self) -> Offset
fn translation(&self) -> Offset
Get translation of children relative to this widget Read more
source§impl<A> Widget for CheckButton<A>
impl<A> Widget for CheckButton<A>
Auto Trait Implementations§
impl<A> !RefUnwindSafe for CheckButton<A>
impl<A> !Send for CheckButton<A>
impl<A> !Sync for CheckButton<A>
impl<A> Unpin for CheckButton<A>
impl<A> !UnwindSafe for CheckButton<A>
Blanket Implementations§
source§impl<W> AdaptWidget for Wwhere
W: Widget,
impl<W> AdaptWidget for Wwhere
W: Widget,
source§fn on_configure<F>(self, f: F) -> AdaptEvents<Self>
fn on_configure<F>(self, f: F) -> AdaptEvents<Self>
Call the given closure on
Events::configure
Read moresource§fn on_update<F>(self, f: F) -> AdaptEvents<Self>
fn on_update<F>(self, f: F) -> AdaptEvents<Self>
Call the given closure on
Events::update
Read moresource§fn on_message<M, H>(self, handler: H) -> AdaptEvents<Self>
fn on_message<M, H>(self, handler: H) -> AdaptEvents<Self>
Add a handler on message of type
M
Read moresource§fn on_messages<H>(self, handler: H) -> AdaptEvents<Self>
fn on_messages<H>(self, handler: H) -> AdaptEvents<Self>
Add a generic message handler Read more
source§fn with_min_size_px(self, w: i32, h: i32) -> Reserve<Self>
fn with_min_size_px(self, w: i32, h: i32) -> Reserve<Self>
Construct a wrapper, setting minimum size in pixels Read more
source§fn with_min_size_em(self, w: f32, h: f32) -> Reserve<Self>
fn with_min_size_em(self, w: f32, h: f32) -> Reserve<Self>
Construct a wrapper, setting minimum size in Em Read more
source§fn with_label<D, T>(self, direction: D, label: T) -> WithLabel<Self, D>
fn with_label<D, T>(self, direction: D, label: T) -> WithLabel<Self, D>
Construct a wrapper widget adding a label Read more
source§impl<W> AdaptWidgetAny for W
impl<W> AdaptWidgetAny for W
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<S, T> Cast<T> for Swhere
T: Conv<S>,
impl<S, T> Cast<T> for Swhere
T: Conv<S>,
§impl<S, T> CastApprox<T> for Swhere
T: ConvApprox<S>,
impl<S, T> CastApprox<T> for Swhere
T: ConvApprox<S>,
§fn try_cast_approx(self) -> Result<T, Error>
fn try_cast_approx(self) -> Result<T, Error>
§fn cast_approx(self) -> T
fn cast_approx(self) -> T
§impl<S, T> CastFloat<T> for Swhere
T: ConvFloat<S>,
impl<S, T> CastFloat<T> for Swhere
T: ConvFloat<S>,
§fn cast_trunc(self) -> T
fn cast_trunc(self) -> T
Cast to integer, truncating Read more
§fn cast_nearest(self) -> T
fn cast_nearest(self) -> T
Cast to the nearest integer Read more
§fn cast_floor(self) -> T
fn cast_floor(self) -> T
Cast the floor to an integer Read more
§fn try_cast_trunc(self) -> Result<T, Error>
fn try_cast_trunc(self) -> Result<T, Error>
Try converting to integer with truncation Read more
§fn try_cast_nearest(self) -> Result<T, Error>
fn try_cast_nearest(self) -> Result<T, Error>
Try converting to the nearest integer Read more
§fn try_cast_floor(self) -> Result<T, Error>
fn try_cast_floor(self) -> Result<T, Error>
Try converting the floor to an integer Read more
§fn try_cast_ceil(self) -> Result<T, Error>
fn try_cast_ceil(self) -> Result<T, Error>
Try convert the ceiling to an integer Read more
source§impl<W> LayoutExt for W
impl<W> LayoutExt for W
source§fn identify(&self) -> IdentifyWidget<'_>
fn identify(&self) -> IdentifyWidget<'_>
Display as “StructName#Id”
source§fn is_strict_ancestor_of(&self, id: &Id) -> bool
fn is_strict_ancestor_of(&self, id: &Id) -> bool
Check whether
id
is not self and is a descendant Read moresource§fn for_children(&self, f: impl FnMut(&dyn Layout))
fn for_children(&self, f: impl FnMut(&dyn Layout))
Run a closure on all children