Flutter macOS Embedder
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).

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

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

676  :(NSEvent*)event {
677  if (event.type == NSEventTypeKeyUp ||
678  (event.type == NSEventTypeFlagsChanged && event.modifierFlags < _previouslyPressedFlags)) {
679  return NO;
680  }
681  _previouslyPressedFlags = event.modifierFlags;
682  if (!_shown) {
683  return NO;
684  }
685 
686  _eventProducedOutput = NO;
687  BOOL res = [_textInputContext handleEvent:event];
688  // NSTextInputContext#handleEvent returns YES if the context handles the event. One of the reasons
689  // the event is handled is because it's a key equivalent. But a key equivalent might produce a
690  // text command (indicated by calling doCommandBySelector) or might not (for example, Cmd+Q). In
691  // the latter case, this command somehow has not been executed yet and Flutter must dispatch it to
692  // the next responder. See https://github.com/flutter/flutter/issues/106354 .
693  // The event is also not redispatched if there is IME composition active, because it might be
694  // handled by the IME. See https://github.com/flutter/flutter/issues/134699
695 
696  // both NSEventModifierFlagNumericPad and NSEventModifierFlagFunction are set for arrow keys.
697  bool is_navigation = event.modifierFlags & NSEventModifierFlagFunction &&
698  event.modifierFlags & NSEventModifierFlagNumericPad;
699  bool is_navigation_in_ime = is_navigation && self.hasMarkedText;
700 
701  if (event.isKeyEquivalent && !is_navigation_in_ime && !_eventProducedOutput) {
702  return NO;
703  }
704  return res;
705 }

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 363 of file FlutterTextInputPlugin.mm.

371  :(id<FlutterTextInputPluginDelegate>)delegate {
372  // The view needs an empty frame otherwise it is visible on dark background.
373  // https://github.com/flutter/flutter/issues/118504
374  self = [super initWithFrame:NSZeroRect];
375  self.clipsToBounds = YES;
376  if (self != nil) {
377  _delegate = delegate;
378  _channel = [FlutterMethodChannel methodChannelWithName:kTextInputChannel
379  binaryMessenger:_delegate.binaryMessenger
380  codec:[FlutterJSONMethodCodec sharedInstance]];
381  _shown = FALSE;
382  // NSTextView does not support _weak reference, so this class has to
383  // use __unsafe_unretained and manage the reference by itself.
384  //
385  // Since the dealloc removes the handler, the pointer should
386  // be valid if the handler is ever called.
387  __unsafe_unretained FlutterTextInputPlugin* unsafeSelf = self;
388  [_channel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
389  [unsafeSelf handleMethodCall:call result:result];
390  }];
391  _textInputContext = [[NSTextInputContext alloc] initWithClient:unsafeSelf];
392  _previouslyPressedFlags = 0;
393 
394  // Initialize with the zero matrix which is not
395  // an affine transform.
396  _editableTransform = CATransform3D();
397  _caretRect = CGRectNull;
398  }
399  return self;
400 }
instancetype methodChannelWithName:binaryMessenger:codec:(NSString *name,[binaryMessenger] NSObject< FlutterBinaryMessenger > *messenger,[codec] NSObject< FlutterMethodCodec > *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 363 of file FlutterTextInputPlugin.mm.

402  {
403  if (!_currentViewController.viewLoaded) {
404  return false;
405  }
406  return [_currentViewController.view.window firstResponder] == self;
407 }

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.

In case of popup windows, this will be the view controller of the closest window in hierarchy above that can receive keyboard input.

Definition at line 57 of file FlutterTextInputPlugin.h.

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

◆ customRunLoopMode

- (NSString*) customRunLoopMode
readwritenonatomicassign

Provided by category FlutterTextInputPlugin(TestMethods).

Definition at line 94 of file FlutterTextInputPlugin.h.

◆ textInputContext

- (NSTextInputContext*) textInputContext
readwritenonatomicassign

Provided by category FlutterTextInputPlugin(TestMethods).

Definition at line 93 of file FlutterTextInputPlugin.h.


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