PipWidget class
Widget that uses PIP callbacks to build some widgets depending on PIP state. At least one of builder or child must not be null. At least one of pipBuilder or pipChild must not be null.
Parameters:
- pipBuilder function is used when app is in PIP mode.
- pipChild widget is used when app is in PIP mode and pipBuilder is null.
- builder function is used when app is not in PIP mode.
- child widget is used when app is not in PIP mode and builder is null.
- onPipEntered function is called when app enters PIP mode.
- onPipExited function is called when app exits PIP mode.
- onPipMaximised function is called when app is opened from PIP.
- pipLayout defines the PIP actions preset layout.
See also:
- AndroidPIP, to handle callbacks.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- PipWidget
Constructors
- PipWidget({Key? key, VoidCallback? onPipEntered, VoidCallback? onPipExited, VoidCallback? onPipMaximised, dynamic onPipAction(PipAction)?, Widget builder(BuildContext)?, Widget? child, Widget pipBuilder(BuildContext)?, Widget? pipChild, PipActionsLayout pipLayout = PipActionsLayout.none, bool useIndexedStack = true})
-
const
Properties
- builder → Widget Function(BuildContext)?
-
final
- child → 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
- onPipAction → dynamic Function(PipAction)?
-
final
- onPipEntered → VoidCallback?
-
final
- onPipExited → VoidCallback?
-
final
- onPipMaximised → VoidCallback?
-
final
- pipBuilder → Widget Function(BuildContext)?
-
final
- pipChild → Widget?
-
final
- pipLayout → PipActionsLayout
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- useIndexedStack → bool
-
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → PipWidgetState -
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