WillPopScope class Null safety

Registers a callback to veto attempts by the user to dismiss the enclosing ModalRoute.

Whenever the back button is pressed, you will get a callback at onWillPop, which returns a Future. If the Future returns true, the screen is popped.
To create a local project with this code sample, run:
flutter create --sample=widgets.WillPopScope.1 mysample

See also:

Inheritance

Constructors

WillPopScope({Key? key, required Widget child, required WillPopCallback? onWillPop})
Creates a widget that registers a callback to veto attempts by the user to dismiss the enclosing ModalRoute.
const

Properties

child → Widget
The widget below this widget in the tree.
final
hashCode → int
The hash code for this object.
nonVirtual">@nonVirtualread-onlyinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onWillPop → WillPopCallback?
Called to veto attempts by the user to dismiss the enclosing ModalRoute.
final
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<WillPopScope>
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.
protected">@protectedinherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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.
nonVirtual">@nonVirtualinherited