YaruCheckbox class

A Yaru checkbox.

The checkbox itself does not maintain any state. Instead, when the state of the checkbox changes, the widget calls the onChanged callback. Most widgets that use a checkbox will listen for the onChanged callback and rebuild the checkbox with a new value to update the visual appearance of the checkbox.

The checkbox can optionally display three values - true, false, and null - if tristate is true. When value is null a dash is displayed. By default tristate is false and the checkbox's value must be true or false.

See also:

Inheritance
Implemented types

Constructors

YaruCheckbox({Key? key, required bool? value, bool tristate = false, required ValueChanged<bool?>? onChanged, Color? selectedColor, Color? checkmarkColor, FocusNode? focusNode, bool autofocus = false, MouseCursor? mouseCursor, MaterialStatesController? statesController})
A Yaru checkbox.
const

Properties

autofocus → bool
True if this widget will be selected as the initial focus when no other node in its scope is currently focused.
final
checked → bool?
Getter used to link T to a bool value. If true, the YaruTogglable will be considered as checked.
no setter
checkmarkColor → Color?
The color to use for the checkmark when this checkbox is checked.
final
focusNode → FocusNode?
An optional focus node to use as the focus node for this widget.
final
hashCode → int
The hash code for this object.
no setterinherited
interactive → bool
Determine if this YaruTogglable can handle events.
no setter
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
mouseCursor → MouseCursor?
The cursor for a mouse pointer when it enters or is hovering over the widget.
final
onChanged → ValueChanged<bool?>?
Called when the value of the checkbox should change.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedColor → Color?
The color to use when this checkbox is checked.
final
statesController → MaterialStatesController?
Controls the states of the YaruTogglable.
final
tristate → bool
If true the checkbox's value can be true, false, or null.
final
value → bool?
Whether this checkbox is checked.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → YaruTogglableState<YaruCheckbox>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited