CarpenterDragScope class final
Shared drag-and-drop runtime for coordinated sources and targets.
The scope also keeps the current operation synchronized with desktop modifier keys while a drag is in progress, so a user can change move/copy/ link intent without restarting the gesture.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- CarpenterDragScope
Constructors
- CarpenterDragScope({Key? key, required Widget child, CarpenterDragController? controller, CarpenterDragSessionCallback? onSessionChanged, TargetPlatform? platform, CarpenterDragOperationPolicy operationPolicy = const CarpenterDragOperationPolicy.standard(), bool trackOperationModifiers = true})
-
Creates a drag runtime boundary around
child.const
Properties
- child → Widget
-
final
- controller → CarpenterDragController?
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onSessionChanged → CarpenterDragSessionCallback?
-
final
- operationPolicy → CarpenterDragOperationPolicy
-
Policy that maps pressed modifier keys to move, copy, or link.
final
- platform → TargetPlatform?
-
Optional platform override, primarily for deterministic policy testing.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- trackOperationModifiers → bool
-
Whether hardware modifier changes may change the active drag operation.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< CarpenterDragScope> -
Creates the state that coordinates controller and hardware-key lifecycles.
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.
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
Static Methods
-
maybeOf(
BuildContext context) → CarpenterDragController? -
of(
BuildContext context) → CarpenterDragController -
resolveOperationOf<
T> (BuildContext context, CarpenterDragPayload< T> payload, {CarpenterDragOperation preferred = CarpenterDragOperation.move}) → CarpenterDragOperation -
Resolves the operation a new
payloadshould use in the nearest scope.