| Flutter macOS Embedder |

Instance Methods | Properties | List of all members
FlutterTextInputPlugin Class Reference

`#import <FlutterTextInputPlugin.h>`

Inheritance diagram for FlutterTextInputPlugin:

## Instance Methods
(instancetype) | - initWithViewController:
(BOOL) | - isFirstResponder
(BOOL) | - handleKeyEvent:
(void) | - handleMethodCall:result:
(NSRect) | - firstRectForCharacterRange:actualRange:
(NSDictionary *) | - editingState

## Properties
FlutterTextField * | client
NSTextInputContext * | textInputContext
NSString * | customRunLoopMode

## Detailed Description

A plugin to handle text input.

Responsible for bridging the native macOS text input system with the Flutter framework text editing classes, via system channels.

This is not an FlutterPlugin since it needs access to FlutterViewController internals, so needs to be managed differently.

When accessibility is on, accessibility bridge creates a NSTextField, i.e. FlutterTextField, for every text field in the Flutter. This plugin acts as a field editor for those NSTextField[s].

Definition at line 29 of file FlutterTextInputPlugin.h.

## Method Documentation

## ◆ editingState

- (NSDictionary*) editingState |  |  |

Provided by category FlutterTextInputPlugin(TestMethods).

Referenced by FlutterInputPluginTestObjc::testClearClientDuringComposing, and FlutterInputPluginTestObjc::testEmptyCompositionRange.

## ◆ firstRectForCharacterRange:actualRange:

- (NSRect) firstRectForCharacterRange: |  | (NSRange) | range
actualRange: |  | (NSRangePointer) | actualRange

Provided by category FlutterTextInputPlugin(TestMethods).

## ◆ handleKeyEvent:

- (BOOL) handleKeyEvent: |  | (NSEvent*) | event |

Handles key down events received from the view controller, responding YES if the event was handled.

Note, the Apple docs suggest that clients should override essentially all the mouse and keyboard event-handling methods of NSResponder. However, experimentation indicates that only key events are processed by the native layer; Flutter processes mouse events. Additionally, processing both keyUp and keyDown results in duplicate processing of the same keys.

Definition at line 607 of file FlutterTextInputPlugin.mm.

607 :(NSEvent*)event {
608 if (event.type == NSEventTypeKeyUp ||
609 (event.type == NSEventTypeFlagsChanged && event.modifierFlags < _previouslyPressedFlags)) {
610 return NO;
611 }
612 _previouslyPressedFlags = event.modifierFlags;
613 if (!_shown) {
614 return NO;
615 }
616
617 _eventProducedOutput = NO;
618 BOOL res = [_textInputContext handleEvent:event];
619 // NSTextInputContext#handleEvent returns YES if the context handles the event. One of the reasons
620 // the event is handled is because it's a key equivalent. But a key equivalent might produce a
621 // text command (indicated by calling doCommandBySelector) or might not (for example, Cmd+Q). In
622 // the latter case, this command somehow has not been executed yet and Flutter must dispatch it to
623 // the next responder. See https://github.com/flutter/flutter/issues/106354 .
624 // The event is also not redispatched if there is IME composition active, because it might be
625 // handled by the IME. See https://github.com/flutter/flutter/issues/134699
626
627 // both NSEventModifierFlagNumericPad and NSEventModifierFlagFunction are set for arrow keys.
628 bool is_navigation = event.modifierFlags & NSEventModifierFlagFunction &&
629 event.modifierFlags & NSEventModifierFlagNumericPad;
630 bool is_navigation_in_ime = is_navigation && self.hasMarkedText;
631
632 if (event.isKeyEquivalent && !is_navigation_in_ime && !_eventProducedOutput) {
633 return NO;
634 }
635 return res;
636 }

## ◆ handleMethodCall:result:

- (void) handleMethodCall: |  | (FlutterMethodCall *) | call
result: |  | (FlutterResult) | result

Provided by category FlutterTextInputPlugin(TestMethods).

Referenced by FlutterInputPluginTestObjc::testClearClientDuringComposing, and FlutterInputPluginTestObjc::testEmptyCompositionRange.

## ◆ initWithViewController:

- (instancetype) initWithViewController: |  | (FlutterViewController*) | viewController |

Initializes a text input plugin that coordinates key event handling with |viewController|.

Definition at line 341 of file FlutterTextInputPlugin.mm.

341 :(FlutterViewController*)viewController {
342 // The view needs an empty frame otherwise it is visible on dark background.
343 // https://github.com/flutter/flutter/issues/118504
344 self = [super initWithFrame:NSZeroRect];
345 self.clipsToBounds = YES;
346 if (self != nil) {
347 _flutterViewController = viewController;
348 _channel = [FlutterMethodChannel methodChannelWithName:kTextInputChannel
349 binaryMessenger:viewController.engine.binaryMessenger
350 codec:[FlutterJSONMethodCodec sharedInstance]];
351 _shown = FALSE;
352 // NSTextView does not support _weak reference, so this class has to
353 // use __unsafe_unretained and manage the reference by itself.
354 //
355 // Since the dealloc removes the handler, the pointer should
356 // be valid if the handler is ever called.
357 __unsafe_unretained FlutterTextInputPlugin* unsafeSelf = self;
358 [_channel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
359 [unsafeSelf handleMethodCall:call result:result];
360 }];
361 _textInputContext = [[NSTextInputContext alloc] initWithClient:unsafeSelf];
362 _previouslyPressedFlags = 0;
363
364 // Initialize with the zero matrix which is not
365 // an affine transform.
366 _editableTransform = CATransform3D();
367 _caretRect = CGRectNull;
368 }
369 return self;
370 }

References _caretRect, _editableTransform, and FlutterMethodChannel::methodChannelWithName:binaryMessenger:codec:.

## ◆ isFirstResponder

- (BOOL) isFirstResponder |  |  |

Whether this plugin is the first responder of this NSWindow.

When accessibility is on, this plugin is set as the first responder to act as the field editor for FlutterTextFields.

Returns false if accessibility is off.

Definition at line 372 of file FlutterTextInputPlugin.mm.

372 {
373 if (!self.flutterViewController.viewLoaded) {
374 return false;
375 }
376 return [self.flutterViewController.view.window firstResponder] == self;
377 }

## Property Documentation

## ◆ client

- (FlutterTextField*) client
| read write nonatomic weak

The NSTextField that currently has this plugin as its field editor.

Must be nil if accessibility is off.

Definition at line 36 of file FlutterTextInputPlugin.h.

Referenced by FlutterTextField::startEditing, and FlutterTextField::updateString:withSelection:.

## ◆ customRunLoopMode

- (NSString*) customRunLoopMode
| read write nonatomic assign

Provided by category FlutterTextInputPlugin(TestMethods).

Definition at line 73 of file FlutterTextInputPlugin.h.

## ◆ textInputContext

- (NSTextInputContext*) textInputContext
| read write nonatomic assign

Provided by category FlutterTextInputPlugin(TestMethods).

Definition at line 72 of file FlutterTextInputPlugin.h.

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

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

FlutterViewController
Definition: FlutterViewController.h:62
FlutterMethodChannel
Definition: FlutterChannels.h:222
FlutterTextInputPlugin
Definition: FlutterTextInputPlugin.h:29
+[FlutterMethodChannel methodChannelWithName:binaryMessenger:codec:]
instancetype methodChannelWithName:binaryMessenger:codec:(NSString *name,[binaryMessenger] NSObject< FlutterBinaryMessenger > *messenger,[codec] NSObject< FlutterMethodCodec > *codec)
FlutterJSONMethodCodec
Definition: FlutterCodecs.h:453
_editableTransform
CATransform3D _editableTransform
Definition: FlutterTextInputPlugin.mm:324
_caretRect
CGRect _caretRect
Definition: FlutterTextInputPlugin.mm:338