Flutter iOS Embedder
accessibility_bridge_ios.h
Go to the documentation of this file.
1 // Copyright 2013 The Flutter Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #ifndef FLUTTER_SHELL_PLATFORM_DARWIN_IOS_FRAMEWORK_SOURCE_ACCESSIBILITY_BRIDGE_IOS_H_
6 #define FLUTTER_SHELL_PLATFORM_DARWIN_IOS_FRAMEWORK_SOURCE_ACCESSIBILITY_BRIDGE_IOS_H_
7 
8 #include <memory>
9 #include <vector>
10 
11 #import "flutter/fml/mapping.h"
12 #include "flutter/lib/ui/semantics/semantics_node.h"
13 
14 @class UIView;
16 
17 namespace flutter {
18 
19 /// Interface that represents an accessibility bridge for iOS.
21  public:
22  virtual ~AccessibilityBridgeIos() = default;
23  virtual UIView* view() const = 0;
24  // Returns the current Flutter view without forcing the owner view controller to load its view.
25  virtual UIView* ViewIfLoaded() const = 0;
26  // Returns a nonnull container used only to initialize UIAccessibilityElements without loading
27  // the owner view controller's view. SemanticsObject overrides accessibilityContainer, so this
28  // view is never exposed as the semantics tree's actual container.
29  virtual UIView* AccessibilityElementInitializationContainer() const = 0;
30  virtual bool isVoiceOverRunning() const = 0;
31  virtual UIView<UITextInput>* textInputView() = 0;
32  virtual void DispatchSemanticsAction(int32_t id, flutter::SemanticsAction action) = 0;
33  virtual void DispatchSemanticsAction(int32_t id,
34  flutter::SemanticsAction action,
35  fml::MallocMapping args) = 0;
36  /**
37  * A callback that is called when a SemanticObject receives focus.
38  *
39  * The input id is the uid of the newly focused SemanticObject.
40  */
41  virtual void AccessibilityObjectDidBecomeFocused(int32_t id) = 0;
42  /**
43  * A callback that is called when a SemanticObject loses focus
44  *
45  * The input id is the uid of the newly focused SemanticObject.
46  */
47  virtual void AccessibilityObjectDidLoseFocus(int32_t id) = 0;
48  virtual NSString* GetDefaultLocale() = 0;
50 };
51 
52 } // namespace flutter
53 
54 #endif // FLUTTER_SHELL_PLATFORM_DARWIN_IOS_FRAMEWORK_SOURCE_ACCESSIBILITY_BRIDGE_IOS_H_
Interface that represents an accessibility bridge for iOS.
virtual void DispatchSemanticsAction(int32_t id, flutter::SemanticsAction action)=0
virtual void AccessibilityObjectDidLoseFocus(int32_t id)=0
virtual bool isVoiceOverRunning() const =0
virtual void AccessibilityObjectDidBecomeFocused(int32_t id)=0
virtual ~AccessibilityBridgeIos()=default
virtual UIView< UITextInput > * textInputView()=0
virtual void DispatchSemanticsAction(int32_t id, flutter::SemanticsAction action, fml::MallocMapping args)=0
virtual UIView * ViewIfLoaded() const =0
virtual UIView * view() const =0
virtual FlutterPlatformViewsController * GetPlatformViewsController() const =0
virtual UIView * AccessibilityElementInitializationContainer() const =0
virtual NSString * GetDefaultLocale()=0