MacosSwitch class
A switch is a control that offers a binary choice between two mutually exclusive states — on and off.
A switch shows that it's on when the activeColor is visible and off when the trackColor is visible.
Additional Reference:
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- MacosSwitch
Constructors
-
MacosSwitch({Key? key, required bool value, ControlSize size = ControlSize.regular, required ValueChanged<
bool> ? onChanged, DragStartBehavior dragStartBehavior = DragStartBehavior.start, MacosColor? activeColor, MacosColor? trackColor, MacosColor? knobColor, String? semanticLabel}) -
A switch is a control that offers a binary choice between two mutually
exclusive states — on and off.
const
Properties
- activeColor → MacosColor?
-
The color to use for the track when this switch is on.
final
- dragStartBehavior → DragStartBehavior
-
Determines the way that drag start behavior is handled.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- knobColor → MacosColor?
-
The color to use for the switch's knob.
final
-
onChanged
→ ValueChanged<
bool> ? -
Called when the user toggles with switch on or off.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticLabel → String?
-
The semantic label used by screen readers.
final
- size → ControlSize
-
The size of the switch, which is ControlSize.regular by default.
final
- trackColor → MacosColor?
-
The color to use for track when this switch is off.
final
- value → bool
-
Whether this switch is on or off.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< MacosSwitch> -
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