Deprecate UpdateLiveRegionEvent (#45940)

This commit is contained in:
Dan Field 2019-12-02 19:08:01 -08:00 committed by Flutter GitHub Bot
parent df0b3fed7b
commit c0283d85f5
2 changed files with 14 additions and 13 deletions

View File

@ -788,12 +788,10 @@ class SemanticsProperties extends DiagnosticableTree {
/// If non-null, whether the node should be considered a live region. /// If non-null, whether the node should be considered a live region.
/// ///
/// On Android, when a live region semantics node is first created TalkBack /// On Android, when the label changes on a live region semantics node,
/// will make a polite announcement of the current label. This announcement /// TalkBack will make a polite announcement of the current label. This
/// occurs even if the node is not focused. Subsequent polite announcements /// announcement occurs even if the node is not focused, but only if the label
/// can be made by sending a [UpdateLiveRegionEvent] semantics event. The /// has changed since the last update.
/// announcement will only be made if the node's label has changed since the
/// last update.
/// ///
/// On iOS, no announcements are made but the node is marked as /// On iOS, no announcements are made but the node is marked as
/// `UIAccessibilityTraitUpdatesFrequently`. /// `UIAccessibilityTraitUpdatesFrequently`.
@ -807,7 +805,6 @@ class SemanticsProperties extends DiagnosticableTree {
/// ///
/// * [SemanticsFlag.liveRegion], the semantics flag this setting controls. /// * [SemanticsFlag.liveRegion], the semantics flag this setting controls.
/// * [SemanticsConfiguration.liveRegion], for a full description of a live region. /// * [SemanticsConfiguration.liveRegion], for a full description of a live region.
/// * [UpdateLiveRegionEvent], to trigger a polite announcement of a live region.
final bool liveRegion; final bool liveRegion;
/// The maximum number of characters that can be entered into an editable /// The maximum number of characters that can be entered into an editable
@ -3522,12 +3519,10 @@ class SemanticsConfiguration {
/// Whether the semantics node is a live region. /// Whether the semantics node is a live region.
/// ///
/// On Android, when a live region semantics node is first created TalkBack /// On Android, when the label changes on a live region semantics node,
/// will make a polite announcement of the current label. This announcement /// TalkBack will make a polite announcement of the current label. This
/// occurs even if the node is not focused. Subsequent polite announcements /// announcement occurs even if the node is not focused, but only if the label
/// can be made by sending a [UpdateLiveRegionEvent] semantics event. The /// has changed since the last update.
/// announcement will only be made if the node's label has changed since the
/// last update.
/// ///
/// An example of a live region is the [Snackbar] widget. When it appears /// An example of a live region is the [Snackbar] widget. When it appears
/// on the screen it may be difficult to focus to read the label. A live /// on the screen it may be difficult to focus to read the label. A live

View File

@ -144,6 +144,12 @@ class TapSemanticEvent extends SemanticsEvent {
/// See also: /// See also:
/// ///
/// * [SemanticsFlag.liveRegion], for a description of live regions. /// * [SemanticsFlag.liveRegion], for a description of live regions.
///
/// Deprecated. This message was never implemented, and references to it should be removed.
@Deprecated(
'This event has never been implemented and will be removed in a future version of Flutter. References to it should be removed. '
'This feature was deprecated after v1.12.16.'
)
class UpdateLiveRegionEvent extends SemanticsEvent { class UpdateLiveRegionEvent extends SemanticsEvent {
/// Creates a new [UpdateLiveRegionEvent]. /// Creates a new [UpdateLiveRegionEvent].
const UpdateLiveRegionEvent() : super('updateLiveRegion'); const UpdateLiveRegionEvent() : super('updateLiveRegion');