Struct Checkerboard

pub struct Checkerboard(/* private fields */);

W A checkerboard visual.

This widget draws a checkerboard pattern, with configurable dimensions and colors.

Implementations

impl Checkerboard

pub fn widget_new() -> Self

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

impl Checkerboard

pub fn colors(&self, colors: impl IntoVar<Colors>)

P Set both checkerboard colors.

The values are the interchanging colors for a given color scheme, for example in the dark color scheme the (colors[0].dark, colors[1].dark) colors are used.

This property sets COLORS_VAR for all inner checkerboard widgets.

impl Checkerboard

pub fn cb_size(&self, size: impl IntoVar<Size>)

P Set the size of a checkerboard color rectangle.

This property sets the SIZE_VAR for all inner checkerboard widgets.

impl Checkerboard

pub fn cb_origin(&self, offset: impl IntoVar<Point>)

P Sets the offset of the checkerboard pattern.

Relative values are resolved in the context of a cb_size.

This property sets the ORIGIN_VAR for all inner checkerboard widgets.

Methods from Deref<Target = WidgetBase>

pub fn widget_builder(&mut self) -> &mut WidgetBuilder

Returns a mutable reference to the widget builder.

pub fn widget_when(&mut self) -> Option<&mut WhenInfo>

Returns a mutable reference to the when block if called inside a when block.

pub fn widget_take(&mut self) -> WidgetBuilder

Takes the widget builder, finishing the widget macro build.

After this call trying to set a property using self will panic, the returned builder can still be manipulated directly.

pub fn widget_build(&mut self) -> impl UiNode

Build the widget.

After this call trying to set a property will panic.

pub fn widget_importance(&mut self) -> &mut Importance

Returns a mutable reference to the importance of the next property assigns, unsets or when blocks.

Note that during the widget_intrinsic call this is Importance::WIDGET and after it is Importance::INSTANCE.

pub fn start_when_block( &mut self, inputs: Box<[WhenInput]>, state: Box<dyn VarBoxed<bool>>, expr: &'static str, location: SourceLocation, )

Start building a when block, all properties set after this call are pushed in the when block.

pub fn end_when_block(&mut self)

End the current when block, all properties set after this call are pushed in the widget.

pub fn id(&self, id: impl IntoValue<WidgetId>)

c Unique ID of the widget instance.

Note that the id can convert from a &'static str unique name.

Trait Implementations

impl Deref for Checkerboard

type Target = WidgetBase

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Checkerboard

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.