| Flutter macOS Embedder |

Classes | Public Member Functions | Protected Member Functions | List of all members
flutter::AccessibilityBridgeMac Class Reference

`#include <AccessibilityBridgeMac.h>`

Inheritance diagram for flutter::AccessibilityBridgeMac:

## Public Member Functions
| AccessibilityBridgeMac (__weak FlutterEngine *flutter_engine, __weak FlutterViewController *view_controller)
| Creates an AccessibilityBridgeMacDelegate. More...
virtual | ~AccessibilityBridgeMac ()=default
void | DispatchAccessibilityAction (AccessibilityNodeId target, FlutterSemanticsAction action, fml::MallocMapping data) override
| Dispatch accessibility action back to the Flutter framework. These actions are generated in the native accessibility system when users interact with the assistive technologies. For example, a FlutterSemanticsAction::kFlutterSemanticsActionTap is fired when user click or touch the screen. More...
Public Member Functions inherited from flutter::AccessibilityBridge
| AccessibilityBridge ()
| Creates a new instance of a accessibility bridge. More...
virtual | ~AccessibilityBridge ()
void | AddFlutterSemanticsNodeUpdate (const FlutterSemanticsNode2 &node)
| Adds a semantics node update to the pending semantics update. Calling this method alone will NOT update the semantics tree. To flush the pending updates, call the CommitUpdates(). More...
void | AddFlutterSemanticsCustomActionUpdate (const FlutterSemanticsCustomAction2 &action)
| Adds a custom semantics action update to the pending semantics update. Calling this method alone will NOT update the semantics tree. To flush the pending updates, call the CommitUpdates(). More...
void | CommitUpdates ()
| Flushes the pending updates and applies them to this accessibility bridge. Calling this with no pending updates does nothing, and callers should call this method at the end of an atomic batch to avoid leaving the tree in a unstable state. For example if a node reparents from A to B, callers should only call this method when both removal from A and addition to B are in the pending updates. More...
std::weak_ptr< FlutterPlatformNodeDelegate > | GetFlutterPlatformNodeDelegateFromID (AccessibilityNodeId id) const
| Get the flutter platform node delegate with the given id from this accessibility bridge. Returns expired weak_ptr if the delegate associated with the id does not exist or has been removed from the accessibility tree. More...
const ui::AXTreeData & | GetAXTreeData () const
| Get the ax tree data from this accessibility bridge. The tree data contains information such as the id of the node that has the keyboard focus or the text selection range. More...
const std::vector< ui::AXEventGenerator::TargetedEvent > | GetPendingEvents () const
| Gets all pending accessibility events generated during semantics updates. This is useful when deciding how to handle events in AccessibilityBridgeDelegate::OnAccessibilityEvent in case one may decide to handle an event differently based on all pending events. More...
ui::AXNode * | GetNodeFromTree (const ui::AXTreeID tree_id, const ui::AXNode::AXID node_id) const override
ui::AXNode * | GetNodeFromTree (const ui::AXNode::AXID node_id) const override
ui::AXTreeID | GetTreeID () const override
ui::AXTreeID | GetParentTreeID () const override
ui::AXNode * | GetRootAsAXNode () const override
ui::AXNode * | GetParentNodeFromParentTreeAsAXNode () const override
ui::AXTree * | GetTree () const override
ui::AXPlatformNode * | GetPlatformNodeFromTree (const ui::AXNode::AXID node_id) const override
ui::AXPlatformNode * | GetPlatformNodeFromTree (const ui::AXNode &node) const override
ui::AXPlatformNodeDelegate * | RootDelegate () const override
Public Member Functions inherited from flutter::FlutterPlatformNodeDelegate::OwnerBridge
virtual | ~OwnerBridge ()=default

## Protected Member Functions
void | OnAccessibilityEvent (ui::AXEventGenerator::TargetedEvent targeted_event) override
| Handle accessibility events generated due to accessibility tree changes. These events are needed to be sent to native accessibility system. See ui::AXEventGenerator::Event for possible events. More...
std::shared_ptr< FlutterPlatformNodeDelegate > | CreateFlutterPlatformNodeDelegate () override
| Creates a platform specific FlutterPlatformNodeDelegate. Ownership passes to the caller. This method will be called whenever a new AXNode is created in AXTree. Each platform needs to implement this method in order to inject its subclass into the accessibility bridge. More...

## Detailed Description

The macOS implementation of AccessibilityBridge.

This interacts with macOS accessibility APIs, which includes routing accessibility events fired from the framework to macOS, routing native macOS accessibility events to the framework, and creating macOS-specific FlutterPlatformNodeDelegate objects for each node in the semantics tree.

AccessibilityBridgeMac must be created as a shared_ptr, since some methods acquires its weak_ptr.

Definition at line 28 of file AccessibilityBridgeMac.h.

## Constructor & Destructor Documentation

## ◆ AccessibilityBridgeMac()

flutter::AccessibilityBridgeMac::AccessibilityBridgeMac | ( | __weak FlutterEngine * | flutter_engine,
|  | __weak FlutterViewController * | view_controller
| ) |  |
| explicit

Creates an AccessibilityBridgeMacDelegate.

Parameters

  [in] | flutter_engine | The weak reference to the FlutterEngine.
  [in] | view_controller | The weak reference to the FlutterViewController.

Definition at line 23 of file AccessibilityBridgeMac.mm.

25 : flutter_engine_(flutter_engine), view_controller_(view_controller) {}

## ◆ ~AccessibilityBridgeMac()

virtual flutter::AccessibilityBridgeMac::~AccessibilityBridgeMac | ( |  | ) |
| virtual default

## Member Function Documentation

## ◆ CreateFlutterPlatformNodeDelegate()

std::shared_ptr< FlutterPlatformNodeDelegate > flutter::AccessibilityBridgeMac::CreateFlutterPlatformNodeDelegate | ( |  | ) |
| override protected virtual

Creates a platform specific FlutterPlatformNodeDelegate. Ownership passes to the caller. This method will be called whenever a new AXNode is created in AXTree. Each platform needs to implement this method in order to inject its subclass into the accessibility bridge.

Implements flutter::AccessibilityBridge.

Definition at line 345 of file AccessibilityBridgeMac.mm.

345 {
346 return std::make_shared<FlutterPlatformNodeDelegateMac>(weak_from_this(), view_controller_);
347 }

## ◆ DispatchAccessibilityAction()

void flutter::AccessibilityBridgeMac::DispatchAccessibilityAction | ( | AccessibilityNodeId | target,
|  | FlutterSemanticsAction | action,
|  | fml::MallocMapping | data
| ) |  |
| override virtual

Dispatch accessibility action back to the Flutter framework. These actions are generated in the native accessibility system when users interact with the assistive technologies. For example, a FlutterSemanticsAction::kFlutterSemanticsActionTap is fired when user click or touch the screen.

Parameters

  [in] | target | The semantics node id of the action target.
  [in] | action | The generated flutter semantics action.
  [in] | data | Additional data associated with the action.

Implements flutter::FlutterPlatformNodeDelegate::OwnerBridge.

Definition at line 332 of file AccessibilityBridgeMac.mm.

334 {
335 // TODO(mattkae): Remove implicit view assumption.
336 // https://github.com/flutter/flutter/issues/142845
337 NSCAssert(flutter_engine_, @"Flutter engine should not be deallocated");
338 NSCAssert(view_controller_.viewLoaded && view_controller_.view.window,
339 @"The accessibility bridge should not receive accessibility actions if the flutter view"
340 @"is not loaded or attached to a NSWindow.");
341 [flutter_engine_ dispatchSemanticsAction:action toTarget:target withData:std::move(data)];
342 }

## ◆ OnAccessibilityEvent()

void flutter::AccessibilityBridgeMac::OnAccessibilityEvent | ( | ui::AXEventGenerator::TargetedEvent | targeted_event | ) |
| override protected virtual

Handle accessibility events generated due to accessibility tree changes. These events are needed to be sent to native accessibility system. See ui::AXEventGenerator::Event for possible events.

Parameters

  [in] | targeted_event | The object that contains both the generated event and the event target.

Implements flutter::AccessibilityBridge.

Definition at line 27 of file AccessibilityBridgeMac.mm.

28 {
29 if (!view_controller_.viewLoaded || !view_controller_.view.window) {
30 // Don't need to send accessibility events if the there is no view or window.
31 return;
32 }
33 ui::AXNode* ax_node = targeted_event.node;
34 std::vector<AccessibilityBridgeMac::NSAccessibilityEvent> events =
35 MacOSEventsFromAXEvent(targeted_event.event_params.event, *ax_node);
36 for (const AccessibilityBridgeMac::NSAccessibilityEvent& event : events) {
37 if (event.user_info != nil) {
38 DispatchMacOSNotificationWithUserInfo(event.target, event.name, event.user_info);
39 } else {
40 DispatchMacOSNotification(event.target, event.name);
41 }
42 }
43 }

The documentation for this class was generated from the following files:

- shell/platform/darwin/macos/framework/Source/AccessibilityBridgeMac.h
- shell/platform/darwin/macos/framework/Source/AccessibilityBridgeMac.mm