CarpenterSwitch class final
Controlled binary setting with a visible label and optional supporting description.
Activation proposes the opposite value. Keep the authoritative setting and any persistence logic outside the widget.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- CarpenterSwitch
Constructors
-
CarpenterSwitch({Key? key, required bool value, required String label, ValueChanged<
bool> ? onChanged, String? description, String? semanticLabel, ControlSize size = ControlSize.medium, SelectionColorRole colorRole = SelectionColorRole.primary, FocusNode? focusNode, bool autofocus = false}) -
Creates a switch from the current
value. NullonChangedmakes it noninteractive.const
Properties
- autofocus → bool
-
Whether the control requests focus when first attached. Defaults to
false.
final
- colorRole → SelectionColorRole
-
Semantic action or selection color resolved from the current Carpenter
theme.
final
- description → String?
-
Optional supporting text explaining the choice without replacing its
accessible name.
final
- focusNode → FocusNode?
-
Optional caller-owned focus node. Dispose a supplied node in its owner,
not in the widget.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- label → String
-
Visible text naming the control or choice; keep it meaningful without
relying on an icon.
final
-
onChanged
→ ValueChanged<
bool> ? -
Receives the proposed opposite setting. Store it and rebuild; null
disables interaction.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticLabel → String?
-
Accessible name supplied to assistive technology. When omitted, the
visible label is used.
final
- size → ControlSize
-
Semantic control size, resolving coordinated height, spacing, icon, and
typography metrics.
final
- value → bool
-
Current enabled/disabled value of the setting, independent of whether
the control itself is interactive.
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 DiagnosticsNode objects 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, int wrapWidth = 65}) → 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