TrayIconWidget class Null safety

A widget that can be used to add a TrayIcon to the system tray.

The icons lifecycle is tied to this widgets _TrayIconWidgetState.

If an icon persists after navigation and you want it gone, you'll have to manually remove it.

TrayIcon.of(context).hide();
Inheritance

Constructors

TrayIconWidget({Key? key, required Widget child, bool? visible = true, bool addToContext = true, String? tooltip, _EventCallback? onTap, _EventCallback? onSecondaryTap, _EventCallback? onTapDown, _EventCallback? onSecondaryTapDown, _EventCallback? onTertiaryTapDown, _EventCallback? onTapUp, _EventCallback? onSecondaryTapUp, _EventCallback? onTertiaryTapUp, _EventCallback? onDoubleTap, _EventCallback? onSecondaryDoubleTap, _EventCallback? onTertiaryDoubleTap, _EventCallback? onPointerMove, TrayIconImageDelegate? imageDelegate, ByteBuffer? imagePixels, String? imageAsset, Uri? imagePath, StockIcon? stockIcon, WinIcon? winIcon})
Manages a TrayIcon as a StatefulWidget.

Properties

addToContext bool
If true, the TrayIcon resource this widget manages will be accessible via TrayIcon.of(context).
final
child Widget
The widget below this widget in the tree.
final
hashCode int
The hash code for this object.
@nonVirtual, read-only, inherited
key Key?
Controls how one widget replaces another widget in the tree.
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
tooltip String?
The tooltip to show when hovering over the TrayIcon.
final
visible bool?
Whether the TrayIcon should be shown or hidden.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<TrayIconWidget>
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, inherited
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, inherited