MacosTooltip class

Tooltips, succinctly describe how to use controls without shifting people’s focus away from the primary interface. Tooltips appear when the user positions the pointer over a control for a few seconds. A tooltip remains visible for 10 seconds, or until the pointer moves away from the control.

The tooltip can respond to long press, on mobile, and to pointer events, on desktop.

See also:

• MacosTooltipThemeData, used to define how the tooltip will look like

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• MacosTooltip

Constructors

MacosTooltip({Key? key, required String message, Widget? child, bool excludeFromSemantics = false, bool useMousePosition = true})

Creates a tooltip.

const

Properties

child → Widget?

The widget the tooltip will be displayed, either above or below, when the mouse is hovering or whenever it gets long pressed.

final

excludeFromSemantics → bool

Whether the tooltip's message should be excluded from the semantics tree.

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

message → String

The text to display in the tooltip.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

useMousePosition → bool

Whether the current mouse position should be used to render the tooltip on the screen. If no mouse is connected, this value is ignored.

final

Methods

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → State<MacosTooltip>

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}) → 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