TourScopeState class Tours

The state of a TourScope: the controller, the target registry and the keyboard shortcuts.

Reach it with TourScope.of. Most apps only need Tour.of, which returns the controller directly.

Inheritance

Constructors

TourScopeState()

Properties

context → BuildContext
The location in the tree where this widget builds.
no setterinherited
controller → TourController
The controller this scope drives.
no setter
hashCode → int
The hash code for this object.
no setterinherited
labels → TourLabels
The words on this scope's step cards.
no setter
lastSpotlight → Rect?
The hole the next step should travel from, or null to appear in place.
no setter
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
theme → HintThemeData?
Visual overrides for every step in this scope.
no setter
widget → TourScope
The current configuration.
no setterinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
clearSpotlight() → void
Forgets the last spotlight, so the next step does not travel.
deactivate() → void
Called when this object is removed from the tree.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
deregisterTarget(String tour, int order) → void
Deregisters a target, called when a HintTarget is disposed.
didChangeDependencies() → void
Called when a dependency of this State object changes.
inherited
didUpdateWidget(covariant TourScope oldWidget) → void
Called whenever the widget configuration changes.
override
disableTarget(String tour, int order) → void
Records that the target for tour at order has opted out of the tour.
dispose() → void
Called when this object is removed from the tree permanently.
override
initState() → void
Called when this object is inserted into the tree.
override
isActiveStep(String tour, int order) → bool
Whether the target for tour at order is the active step.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
orderAt(String tour, int index) → int?
The order that step index of tour refers to, or null when no target has claimed that position yet.
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
registerTarget(String tour, int order, VoidCallback onTourChanged) → void
Registers a target for tour at order.
reportSpotlight(Rect rect) → void
Records where a step's spotlight is, for the step after it.
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
inherited
stepCount(String tour) → int
How many steps tour has.
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
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited