| Flutter macOS Embedder |

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

`#import <FlutterTextInputPlugin.h>`

Inheritance diagram for FlutterTextInputPlugin:

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

## Properties
FlutterTextField * | client
FlutterViewController * | currentViewController
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 41 of file FlutterTextInputPlugin.h.

## Method Documentation

## ◆ editingState

- (NSDictionary*) editingState |  |  |

Provided by category FlutterTextInputPlugin(TestMethods).

## ◆ 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 342 of file FlutterTextInputPlugin.mm.

626 :(NSEvent*)event {
627 if (event.type == NSEventTypeKeyUp ||
628 (event.type == NSEventTypeFlagsChanged && event.modifierFlags < _previouslyPressedFlags)) {
629 return NO;
630 }
631 _previouslyPressedFlags = event.modifierFlags;
632 if (!_shown) {
633 return NO;
634 }
635
636 _eventProducedOutput = NO;
637 BOOL res = [_textInputContext handleEvent:event];
638 // NSTextInputContext#handleEvent returns YES if the context handles the event. One of the reasons
639 // the event is handled is because it's a key equivalent. But a key equivalent might produce a
640 // text command (indicated by calling doCommandBySelector) or might not (for example, Cmd+Q). In
641 // the latter case, this command somehow has not been executed yet and Flutter must dispatch it to
642 // the next responder. See https://github.com/flutter/flutter/issues/106354 .
643 // The event is also not redispatched if there is IME composition active, because it might be
644 // handled by the IME. See https://github.com/flutter/flutter/issues/134699
645
646 // both NSEventModifierFlagNumericPad and NSEventModifierFlagFunction are set for arrow keys.
647 bool is_navigation = event.modifierFlags & NSEventModifierFlagFunction &&
648 event.modifierFlags & NSEventModifierFlagNumericPad;
649 bool is_navigation_in_ime = is_navigation && self.hasMarkedText;
650
651 if (event.isKeyEquivalent && !is_navigation_in_ime && !_eventProducedOutput) {
652 return NO;
653 }
654 return res;
655 }

References FlutterMethodChannel::methodChannelWithName:binaryMessenger:codec:.

## ◆ handleMethodCall:result:

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

Provided by category FlutterTextInputPlugin(TestMethods).

Referenced by flutter::testing::TEST().

## ◆ initWithDelegate:

- (instancetype) initWithDelegate: |  | (id<FlutterTextInputPluginDelegate>) | delegate |

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

Definition at line 342 of file FlutterTextInputPlugin.mm.

350 :(id<FlutterTextInputPluginDelegate>)delegate {
351 // The view needs an empty frame otherwise it is visible on dark background.
352 // https://github.com/flutter/flutter/issues/118504
353 self = [super initWithFrame:NSZeroRect];
354 self.clipsToBounds = YES;
355 if (self != nil) {
356 _delegate = delegate;
357 _channel = [FlutterMethodChannel methodChannelWithName:kTextInputChannel
358 binaryMessenger:_delegate.binaryMessenger
359 codec:[FlutterJSONMethodCodec sharedInstance]];
360 _shown = FALSE;
361 // NSTextView does not support _weak reference, so this class has to
362 // use __unsafe_unretained and manage the reference by itself.
363 //
364 // Since the dealloc removes the handler, the pointer should
365 // be valid if the handler is ever called.
366 __unsafe_unretained FlutterTextInputPlugin* unsafeSelf = self;
367 [_channel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
368 [unsafeSelf handleMethodCall:call result:result];
369 }];
370 _textInputContext = [[NSTextInputContext alloc] initWithClient:unsafeSelf];
371 _previouslyPressedFlags = 0;
372
373 // Initialize with the zero matrix which is not
374 // an affine transform.
375 _editableTransform = CATransform3D();
376 _caretRect = CGRectNull;
377 }
378 return self;
379 }
FlutterJSONMethodCodec
Definition: FlutterCodecs.h:455
FlutterMethodChannel
Definition: FlutterChannels.h:221
+[FlutterMethodChannel methodChannelWithName:binaryMessenger:codec:]
instancetype methodChannelWithName:binaryMessenger:codec:(NSString *name,[binaryMessenger] NSObject< FlutterBinaryMessenger > *messenger,[codec] NSObject< FlutterMethodCodec > *codec)
FlutterTextInputPlugin
Definition: FlutterTextInputPlugin.h:42

## ◆ 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 342 of file FlutterTextInputPlugin.mm.

381 {
382 if (!_currentViewController.viewLoaded) {
383 return false;
384 }
385 return [_currentViewController.view.window firstResponder] == self;
386 }

## Property Documentation

## ◆ client

- (FlutterTextField*) client
| readwritenonatomicweak

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

Must be nil if accessibility is off.

Definition at line 48 of file FlutterTextInputPlugin.h.

## ◆ currentViewController

- (FlutterViewController*) currentViewController
| readnonatomicweak

Returns the view controller text input plugin is currently attached to, nil if not attached to any view controller.

Definition at line 54 of file FlutterTextInputPlugin.h.

Referenced by flutter::testing::TEST().

## ◆ customRunLoopMode

- (NSString*) customRunLoopMode
| readwritenonatomicassign

Provided by category FlutterTextInputPlugin(TestMethods).

Definition at line 91 of file FlutterTextInputPlugin.h.

## ◆ textInputContext

- (NSTextInputContext*) textInputContext
| readwritenonatomicassign

Provided by category FlutterTextInputPlugin(TestMethods).

Definition at line 90 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