semantics_service.dart 1.72 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5

6 7 8 9
import 'dart:ui' show TextDirection;

import 'package:flutter/services.dart' show SystemChannels;

10
import 'semantics_event.dart' show AnnounceSemanticsEvent, TooltipSemanticsEvent;
11 12 13 14 15 16 17 18 19 20


/// Allows access to the platform's accessibility services.
///
/// Events sent by this service are handled by the platform-specific
/// accessibility bridge in Flutter's engine.
///
/// When possible, prefer using mechanisms like [Semantics] to implicitly
/// trigger announcements over using this event.
class SemanticsService {
21
  // This class is not meant to be instantiated or extended; this constructor
22 23
  // prevents instantiation and extension.
  // ignore: unused_element
24 25 26 27 28 29 30 31 32
  SemanticsService._();

  /// Sends a semantic announcement.
  ///
  /// This should be used for announcement that are not seamlessly announced by
  /// the system as a result of a UI state change.
  ///
  /// For example a camera application can use this method to make accessibility
  /// announcements regarding objects in the viewfinder.
33
  static Future<void> announce(String message, TextDirection textDirection) async {
34
    final AnnounceSemanticsEvent event = AnnounceSemanticsEvent(message, textDirection);
35 36
    await SystemChannels.accessibility.send(event.toMap());
  }
37 38

  /// Sends a semantic announcement of a tooltip.
39
  ///
40 41
  /// Currently only honored on Android. The contents of [message] will be
  /// read by TalkBack.
42
  static Future<void> tooltip(String message) async {
43
    final TooltipSemanticsEvent event = TooltipSemanticsEvent(message);
44 45
    await SystemChannels.accessibility.send(event.toMap());
  }
46
}