ScreenSaverWrapper class
A widget that wraps around a child and shows a screen saver after a period of user inactivity.
It listens for user interaction and resets the inactivity timer. If the user is inactive for inactivityDuration, it activates a screen saver.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ScreenSaverWrapper
Constructors
-
ScreenSaverWrapper.new({Key? key, required Widget child, required List<
ScreenSaverMedia> mediaItems, Duration inactivityDuration = const Duration(minutes: 1), Duration slideDuration = const Duration(seconds: 5), Curve slideCurve = Curves.easeInOut, Color backgroundColor = Colors.black}) -
Creates a ScreenSaverWrapper widget.
const
Properties
- backgroundColor → Color
-
The background color of the screen saver.
final
- child → Widget
-
The main content of the app over which the screen saver will appear.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- inactivityDuration → Duration
-
The duration of inactivity after which the screen saver activates.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
mediaItems
→ List<
ScreenSaverMedia> -
A list of media items to display in the screen saver.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- slideCurve → Curve
-
The animation curve for slide transitions.
final
- slideDuration → Duration
-
Duration between slide transitions in the screen saver.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< ScreenSaverWrapper> -
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.
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