| Flutter macOS Embedder |

Instance Methods | Properties | List of all members
FlutterViewController() Category Reference

`#import <FlutterViewController_Internal.h>`

Inheritance diagram for FlutterViewController():

## Instance Methods
(BOOL) | - launchEngine
(void) | - configureTrackingArea
(void) | - initializeKeyboard
(void) | - dispatchMouseEvent:
(void) | - dispatchGestureEvent:
(void) | - dispatchMouseEvent:phase:
(void) | - onKeyboardLayoutChanged
(BOOL) | - isDispatchingKeyEvent:
(void) | - setUpWithEngine:viewId:threadSynchronizer:
(void) | - detachFromEngine
(void) | - notifySemanticsEnabledChanged
(void) | - updateSemantics:

## Properties
NSTrackingArea * | trackingArea
MouseState | mouseState
id | keyUpMonitor
FlutterKeyboardManager * | keyboardManager
KeyboardLayoutNotifier | keyboardLayoutNotifier
NSData * | keyboardLayoutData
FlutterViewId | viewId
FlutterView * | flutterView
FlutterTextInputPlugin * | textInputPlugin
std::weak_ptr< flutter::AccessibilityBridgeMac > | accessibilityBridge

## Detailed Description

Private interface declaration for FlutterViewController.

Definition at line 172 of file FlutterViewController.mm.

## Method Documentation

## ◆ configureTrackingArea

- (void) configureTrackingArea |  |  |

Updates |trackingArea| for the current tracking settings, creating it with the correct mode if tracking is enabled, or removing it if not.

## ◆ detachFromEngine

- (void) detachFromEngine |  |  |

Reset the `engine` and `id` of this controller.

This method is called by FlutterEngine.

## ◆ dispatchGestureEvent:

- (void) dispatchGestureEvent: |  | (nonnull NSEvent *) | event |

Calls dispatchMouseEvent:phase: with a phase determined by event.phase.

## ◆ dispatchMouseEvent:

- (void) dispatchMouseEvent: |  | (nonnull NSEvent *) | event |

Calls dispatchMouseEvent:phase: with a phase determined by self.mouseState.

mouseState.buttons should be updated before calling this method.

## ◆ dispatchMouseEvent:phase:

- (void) dispatchMouseEvent: |  | (nonnull NSEvent *) | event
phase: |  | (FlutterPointerPhase) | phase

Converts |event| to a FlutterPointerEvent with the given phase, and sends it to the engine.

## ◆ initializeKeyboard

- (void) initializeKeyboard |  |  |

Creates and registers keyboard related components.

## ◆ isDispatchingKeyEvent:

- (BOOL) isDispatchingKeyEvent: |  | (nonnull NSEvent *) | event |

Returns YES if provided event is being currently redispatched by keyboard manager.

## ◆ launchEngine

- (BOOL) launchEngine |  |  |

Starts running |engine|, including any initial setup.

## ◆ notifySemanticsEnabledChanged

- (void) notifySemanticsEnabledChanged |  |  |

Called by the associated FlutterEngine when FlutterEngine::semanticsEnabled has changed.

## ◆ onKeyboardLayoutChanged

- (void) onKeyboardLayoutChanged |  |  |

Called when the active keyboard input source changes.

Input sources may be simple keyboard layouts, or more complex input methods involving an IME, such as Chinese, Japanese, and Korean.

## ◆ setUpWithEngine:viewId:threadSynchronizer:

- (void) setUpWithEngine: |  | (nonnull FlutterEngine *) | engine
viewId: |  | (FlutterViewId) | viewId
threadSynchronizer: |  | (nonnull FlutterThreadSynchronizer *) | threadSynchronizer

Set up the controller with `engine` and `id`, and other engine-level classes.

This method is called by FlutterEngine. A view controller must be set up before being used, and must be set up only once until detachFromEngine:.

## ◆ updateSemantics:

- (void) updateSemantics: |  | (nonnull const FlutterSemanticsUpdate2 *) | update |

Notify from the framework that the semantics for this view needs to be updated.

## Property Documentation

## ◆ accessibilityBridge

- (weak_ptr<)flutter:
| readnonatomicassign

Definition at line 34 of file FlutterViewController_Internal.h.

## ◆ flutterView

- (FlutterView*) flutterView
| readnonatomicassign

Definition at line 27 of file FlutterViewController_Internal.h.

## ◆ keyboardLayoutData

- (NSData*) keyboardLayoutData
| readwritenonatomicassign

Definition at line 198 of file FlutterViewController.mm.

## ◆ keyboardLayoutNotifier

- (KeyboardLayoutNotifier) keyboardLayoutNotifier
| readwritenonatomicassign

Definition at line 196 of file FlutterViewController.mm.

## ◆ keyboardManager

- (FlutterKeyboardManager*) keyboardManager
| readnonatomicassign

Pointer to a keyboard manager, a hub that manages how key events are dispatched to various Flutter key responders, and whether the event is propagated to the next NSResponder.

Definition at line 194 of file FlutterViewController.mm.

## ◆ keyUpMonitor

- (id) keyUpMonitor
| readwritenonatomicassign

Event monitor for keyUp events.

Definition at line 187 of file FlutterViewController.mm.

## ◆ mouseState

- (MouseState) mouseState
| readwritenonatomicassign

The current state of the mouse and the sent mouse events.

Definition at line 182 of file FlutterViewController.mm.

## ◆ textInputPlugin

- (FlutterTextInputPlugin*) textInputPlugin
| readnonatomicassign

The text input plugin that handles text editing state for text fields.

Definition at line 32 of file FlutterViewController_Internal.h.

## ◆ trackingArea

- (NSTrackingArea*) trackingArea
| readwritenonatomicassign

The tracking area used to generate hover events, if enabled.

Definition at line 177 of file FlutterViewController.mm.

## ◆ viewId

- (FlutterViewId) viewId
| readnonatomicassign

The identifier for this view controller.

The ID is assigned by FlutterEngine when the view controller is attached.

If the view controller is unattached (see attached (FlutterViewController)), reading this property throws an assertion.

Definition at line 24 of file FlutterViewController_Internal.h.

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

- shell/platform/darwin/macos/framework/Source/FlutterViewController.mm
- shell/platform/darwin/macos/framework/Source/FlutterViewController_Internal.h