semantics library

The Flutter semantics package.

To use, import package:flutter/semantics.dart.

The SemanticsEvent classes define the protocol for sending semantic events to the platform.

The SemanticsNode hierarchy represents the semantic structure of the UI and is used by the platform-specific accessibility services.

Classes

AccessibilityFeatures
Additional accessibility features that may be enabled by the platform. [...]
AnnounceSemanticsEvent
An event for a semantic announcement. [...]
CustomSemanticsAction
An identifier of a custom semantics action. [...]
LongPressSemanticsEvent
An event which triggers long press semantic feedback. [...]
OrdinalSortKey
A SemanticsSortKey that sorts simply based on the double value it is given. [...]
SemanticsAction
The possible actions that can be conveyed from the operating system accessibility APIs to a semantics node.
SemanticsConfiguration
Describes the semantic information associated with the owning RenderObject. [...]
SemanticsData
Summary information about a SemanticsNode object. [...]
SemanticsEvent
An event sent by the application to notify interested listeners that something happened to the user interface (e.g. a view scrolled). [...]
SemanticsHintOverrides
Provides hint values which override the default hints on supported platforms. [...]
SemanticsNode
A node that represents some semantic data. [...]
SemanticsOwner
Owns SemanticsNode objects and notifies listeners of changes to the render tree semantics. [...]
SemanticsProperties
Contains properties used by assistive technologies to make the application more accessible. [...]
SemanticsService
Allows access to the platform's accessibility services. [...]
SemanticsSortKey
Base class for all sort keys for Semantics accessibility traversal order sorting. [...]
SemanticsTag
A tag for a SemanticsNode. [...]
TapSemanticEvent
An event which triggers tap semantic feedback. [...]
TooltipSemanticsEvent
An event for a semantic announcement of a tooltip. [...]
UpdateLiveRegionEvent
An event which triggers a polite announcement of a live region. [...]

Mixins

SemanticsBinding
The glue between the semantics layer and the Flutter engine.

Properties

debugSemanticsDisableAnimations ↔ bool
Overrides the setting of SemanticsBinding.disableAnimations for debugging and testing. [...]
read / write

Functions

debugResetSemanticsIdCounter() → void
In tests use this function to reset the counter used to generate SemanticsNode.id.

Enums

DebugSemanticsDumpOrder
Used by debugDumpSemanticsTree to specify the order in which child nodes are printed.

Typedefs

MoveCursorHandler(bool extendSelection) → void
Signature for SemanticsActions that move the cursor. [...]
SemanticsNodeVisitor(SemanticsNode node) → bool
Signature for a function that is called for each SemanticsNode. [...]
SetSelectionHandler(TextSelection selection) → void
Signature for the SemanticsAction.setSelection handlers to change the text selection (or re-position the cursor) to selection.