ArnaSwitch class
An Arna-styled switch.
Used to toggle the on/off state of a single setting.
The switch itself does not maintain any state. Instead, when the state of the switch changes, the widget calls the onChanged callback. Most widgets that use a switch will listen for the onChanged callback and rebuild the switch with a new value to update the visual appearance of the switch.
If the onChanged callback is null, then the switch will be disabled (it will not respond to input).
See also:
- ArnaSwitchListTile, which combines this widget with an ArnaListTile so that you can give the switch a label.
- ArnaCheckbox, another widget with similar semantics.
- ArnaRadio, for selecting among a set of explicit values.
- ArnaSlider, for selecting a value in a range.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- ArnaSwitch
Constructors
-
ArnaSwitch({Key? key, required bool value, required ValueChanged<
bool> ? onChanged, bool isFocusable = true, bool autofocus = false, Color? accentColor, MouseCursor cursor = MouseCursor.defer, String? semanticLabel}) -
Constructor
const
Properties
- accentColor → Color?
-
The color of the switch's focused border and selected state.
final
- autofocus → bool
-
Whether this switch should focus itself if nothing else is already focused.
final
- cursor → MouseCursor
-
The cursor for a mouse pointer when it enters or is hovering over the switch.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isFocusable → bool
-
Whether this switch is focusable or not.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onChanged
→ ValueChanged<
bool> ? -
Called when the user toggles the switch on or off.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticLabel → String?
-
The semantic label of the switch.
final
- value → bool
-
Whether this switch is on or off.
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's location in the tree.
inherited
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNodeobjects describing this node's children.inherited -
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
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