Struct cosmic::iced_widget::checkbox::Checkbox
source · pub struct Checkbox<'a, Message, Theme = Theme, Renderer = Renderer>{ /* private fields */ }
Expand description
A box that can be checked.
§Example
use iced::widget::checkbox;
struct State {
is_checked: bool,
}
enum Message {
CheckboxToggled(bool),
}
fn view(state: &State) -> Element<'_, Message> {
checkbox("Toggle me!", state.is_checked)
.on_toggle(Message::CheckboxToggled)
.into()
}
fn update(state: &mut State, message: Message) {
match message {
Message::CheckboxToggled(is_checked) => {
state.is_checked = is_checked;
}
}
}
Implementations§
source§impl<'a, Message, Theme, Renderer> Checkbox<'a, Message, Theme, Renderer>
impl<'a, Message, Theme, Renderer> Checkbox<'a, Message, Theme, Renderer>
sourcepub fn new(
label: impl Into<String>,
is_checked: bool,
) -> Checkbox<'a, Message, Theme, Renderer>
pub fn new( label: impl Into<String>, is_checked: bool, ) -> Checkbox<'a, Message, Theme, Renderer>
sourcepub fn on_toggle_maybe<F>(
self,
f: Option<F>,
) -> Checkbox<'a, Message, Theme, Renderer>
pub fn on_toggle_maybe<F>( self, f: Option<F>, ) -> Checkbox<'a, Message, Theme, Renderer>
Sets the function that will be called when the Checkbox
is toggled,
if Some
.
If None
, the checkbox will be disabled.
sourcepub fn size(
self,
size: impl Into<Pixels>,
) -> Checkbox<'a, Message, Theme, Renderer>
pub fn size( self, size: impl Into<Pixels>, ) -> Checkbox<'a, Message, Theme, Renderer>
Sets the size of the Checkbox
.
sourcepub fn width(
self,
width: impl Into<Length>,
) -> Checkbox<'a, Message, Theme, Renderer>
pub fn width( self, width: impl Into<Length>, ) -> Checkbox<'a, Message, Theme, Renderer>
Sets the width of the Checkbox
.
sourcepub fn spacing(
self,
spacing: impl Into<Pixels>,
) -> Checkbox<'a, Message, Theme, Renderer>
pub fn spacing( self, spacing: impl Into<Pixels>, ) -> Checkbox<'a, Message, Theme, Renderer>
Sets the spacing between the Checkbox
and the text.
sourcepub fn text_size(
self,
text_size: impl Into<Pixels>,
) -> Checkbox<'a, Message, Theme, Renderer>
pub fn text_size( self, text_size: impl Into<Pixels>, ) -> Checkbox<'a, Message, Theme, Renderer>
Sets the text size of the Checkbox
.
sourcepub fn text_line_height(
self,
line_height: impl Into<LineHeight>,
) -> Checkbox<'a, Message, Theme, Renderer>
pub fn text_line_height( self, line_height: impl Into<LineHeight>, ) -> Checkbox<'a, Message, Theme, Renderer>
Sets the text text::LineHeight
of the Checkbox
.
sourcepub fn text_shaping(
self,
shaping: Shaping,
) -> Checkbox<'a, Message, Theme, Renderer>
pub fn text_shaping( self, shaping: Shaping, ) -> Checkbox<'a, Message, Theme, Renderer>
Sets the text::Shaping
strategy of the Checkbox
.
sourcepub fn text_wrapping(
self,
wrapping: Wrapping,
) -> Checkbox<'a, Message, Theme, Renderer>
pub fn text_wrapping( self, wrapping: Wrapping, ) -> Checkbox<'a, Message, Theme, Renderer>
Sets the text::Wrapping
strategy of the Checkbox
.
sourcepub fn font(
self,
font: impl Into<<Renderer as Renderer>::Font>,
) -> Checkbox<'a, Message, Theme, Renderer>
pub fn font( self, font: impl Into<<Renderer as Renderer>::Font>, ) -> Checkbox<'a, Message, Theme, Renderer>
Sets the Renderer::Font
of the text of the Checkbox
.
sourcepub fn icon(
self,
icon: Icon<<Renderer as Renderer>::Font>,
) -> Checkbox<'a, Message, Theme, Renderer>
pub fn icon( self, icon: Icon<<Renderer as Renderer>::Font>, ) -> Checkbox<'a, Message, Theme, Renderer>
sourcepub fn style(
self,
style: impl Fn(&Theme, Status) -> Style + 'a,
) -> Checkbox<'a, Message, Theme, Renderer>
pub fn style( self, style: impl Fn(&Theme, Status) -> Style + 'a, ) -> Checkbox<'a, Message, Theme, Renderer>
Sets the style of the Checkbox
.
sourcepub fn class(
self,
class: impl Into<<Theme as Catalog>::Class<'a>>,
) -> Checkbox<'a, Message, Theme, Renderer>
pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> Checkbox<'a, Message, Theme, Renderer>
Sets the style class of the Checkbox
.
sourcepub fn name(
self,
name: impl Into<Cow<'a, str>>,
) -> Checkbox<'a, Message, Theme, Renderer>
pub fn name( self, name: impl Into<Cow<'a, str>>, ) -> Checkbox<'a, Message, Theme, Renderer>
Sets the name of the Checkbox
.
Trait Implementations§
source§impl<'a, Message, Theme, Renderer> From<Checkbox<'a, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>
impl<'a, Message, Theme, Renderer> From<Checkbox<'a, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>
source§impl<'a, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Checkbox<'a, Message, Theme, Renderer>
impl<'a, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Checkbox<'a, Message, Theme, Renderer>
source§fn a11y_nodes(
&self,
layout: Layout<'_>,
_state: &Tree,
cursor: Cursor,
) -> A11yTree
fn a11y_nodes( &self, layout: Layout<'_>, _state: &Tree, cursor: Cursor, ) -> A11yTree
get the a11y nodes for the widget
source§fn on_event(
&mut self,
_tree: &mut Tree,
event: Event,
layout: Layout<'_>,
cursor: Cursor,
_renderer: &Renderer,
_clipboard: &mut dyn Clipboard,
shell: &mut Shell<'_, Message>,
_viewport: &Rectangle,
) -> Status
fn on_event( &mut self, _tree: &mut Tree, event: Event, layout: Layout<'_>, cursor: Cursor, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, ) -> Status
source§fn mouse_interaction(
&self,
_tree: &Tree,
layout: Layout<'_>,
cursor: Cursor,
_viewport: &Rectangle,
_renderer: &Renderer,
) -> Interaction
fn mouse_interaction( &self, _tree: &Tree, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction
source§fn draw(
&self,
tree: &Tree,
renderer: &mut Renderer,
theme: &Theme,
defaults: &Style,
layout: Layout<'_>,
cursor: Cursor,
viewport: &Rectangle,
)
fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, defaults: &Style, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, )
Draws the
Widget
using the associated Renderer
.source§fn set_id(&mut self, id: Id)
fn set_id(&mut self, id: Id)
Sets the id of the widget
This may be called while diffing the widget tree
source§fn operate(
&self,
_state: &mut Tree,
_layout: Layout<'_>,
_renderer: &Renderer,
_operation: &mut dyn Operation,
)
fn operate( &self, _state: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _operation: &mut dyn Operation, )
source§fn overlay<'a>(
&'a mut self,
_state: &'a mut Tree,
_layout: Layout<'_>,
_renderer: &Renderer,
_translation: Vector,
) -> Option<Element<'a, Message, Theme, Renderer>>
fn overlay<'a>( &'a mut self, _state: &'a mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>
Returns the overlay of the
Widget
, if there is any.source§fn drag_destinations(
&self,
_state: &Tree,
_layout: Layout<'_>,
_renderer: &Renderer,
_dnd_rectangles: &mut DndDestinationRectangles,
)
fn drag_destinations( &self, _state: &Tree, _layout: Layout<'_>, _renderer: &Renderer, _dnd_rectangles: &mut DndDestinationRectangles, )
Adds the drag destination rectangles of the widget.
Runs after the layout phase for each widget in the tree.
Auto Trait Implementations§
impl<'a, Message, Theme, Renderer> Freeze for Checkbox<'a, Message, Theme, Renderer>
impl<'a, Message, Theme = Theme, Renderer = Renderer> !RefUnwindSafe for Checkbox<'a, Message, Theme, Renderer>
impl<'a, Message, Theme = Theme, Renderer = Renderer> !Send for Checkbox<'a, Message, Theme, Renderer>
impl<'a, Message, Theme = Theme, Renderer = Renderer> !Sync for Checkbox<'a, Message, Theme, Renderer>
impl<'a, Message, Theme, Renderer> Unpin for Checkbox<'a, Message, Theme, Renderer>
impl<'a, Message, Theme = Theme, Renderer = Renderer> !UnwindSafe for Checkbox<'a, Message, Theme, Renderer>
Blanket Implementations§
source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
Convert the source color to the destination color using the specified
method.
source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
Convert the source color to the destination color using the bradford
method by default.
source§impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
Cast a collection of colors into a collection of arrays.
source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
Cast this collection of arrays into a collection of colors.
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
source§impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
source§type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
The number type that’s used in
parameters
when converting.source§fn cam16_into_unclamped(
self,
parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>,
) -> T
fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T
Converts
self
into C
, using the provided parameters.source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
Cast a collection of colors into a collection of color components.
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
Performs a conversion from
angle
.source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
Converts
other
into Self
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
source§fn into_angle(self) -> U
fn into_angle(self) -> U
Performs a conversion into
T
.source§impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
source§type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
The number type that’s used in
parameters
when converting.source§fn into_cam16_unclamped(
self,
parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>,
) -> T
fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T
Converts
self
into C
, using the provided parameters.source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
source§fn into_color(self) -> U
fn into_color(self) -> U
Convert into T with values clamped to the color defined bounds Read more
source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
Convert into T. The resulting color might be invalid in its color space Read more
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
Converts
self
into T
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
source§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
The error for when
try_into_colors
fails to cast.source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
Try to cast this collection of color components into a collection of
colors. Read more
source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
Convert into T, returning ok if the color is inside of its defined
range, otherwise an
OutOfBounds
error is returned which contains
the unclamped color. Read moresource§impl<C, U> UintsFrom<C> for Uwhere
C: IntoUints<U>,
impl<C, U> UintsFrom<C> for Uwhere
C: IntoUints<U>,
source§fn uints_from(colors: C) -> U
fn uints_from(colors: C) -> U
Cast a collection of colors into a collection of unsigned integers.
source§impl<C, U> UintsInto<C> for Uwhere
C: FromUints<U>,
impl<C, U> UintsInto<C> for Uwhere
C: FromUints<U>,
source§fn uints_into(self) -> C
fn uints_into(self) -> C
Cast this collection of unsigned integers into a collection of colors.