#include <FlutterTextInputPlugin.h>

Inheritance diagram for FlutterTextInputPlugin:

Instance Methods
(instancetype)	- NS_UNAVAILABLE

(instancetype)	- initWithDelegate:

(void)	- handleMethodCall:result:

(UIView< UITextInput > *)	- textInputView

(void)	- setUpIndirectScribbleInteraction:

(void)	- resetViewResponder

(BOOL)	- showEditMenu:

(ios(16.0)	- API_AVAILABLE

(instancetype)	- initWithViewController:

(BOOL)	- isFirstResponder

(BOOL)	- handleKeyEvent:

(void)	- handleKeyboardWillShow: `[implementation]`

(void)	- dealloc `[implementation]`

(void)	- removeEnableFlutterTextInputViewAccessibilityTimer `[implementation]`

(void)	- handlePointerUp: `[implementation]`

(void)	- dismissKeyboardScreenshot `[implementation]`

(void)	- showKeyboardAndRemoveScreenshot `[implementation]`

(void)	- handlePointerMove: `[implementation]`

(void)	- setKeyboardContainerHeight: `[implementation]`

(void)	- hideKeyboardWithoutAnimationAndAvoidCursorDismissUpdate `[implementation]`

(void)	- takeKeyboardScreenshotAndDisplay `[implementation]`

(void)	- hideEditMenu `[implementation]`

(void)	- setEditableSizeAndTransform: `[implementation]`

(void)	- updateMarkedRect: `[implementation]`

(void)	- setSelectionRects: `[implementation]`

(void)	- startLiveTextInput `[implementation]`

(void)	- showTextInput `[implementation]`

(void)	- enableActiveViewAccessibility `[implementation]`

(void)	- hideTextInput `[implementation]`

(void)	- triggerAutofillSave: `[implementation]`

(void)	- setPlatformViewTextInputClient `[implementation]`

(void)	- setTextInputClient:withConfiguration: `[implementation]`

(FlutterTextInputView *)	- createInputViewWith: `[implementation]`

(FlutterTextInputView *)	- updateAndShowAutofillViews:focusedField:isPasswordRelated: `[implementation]`

(FlutterTextInputView *)	- getOrCreateAutofillableView:isPasswordAutofill: `[implementation]`

(UIView *)	- hostView `[implementation]`

(NSArray< UIView * > *)	- textInputViews `[implementation]`

(void)	- cleanUpViewHierarchy:clearText:delayRemoval: `[implementation]`

(void)	- changeInputViewsAutofillVisibility: `[implementation]`

(void)	- resetAllClientIds `[implementation]`

(void)	- addToInputParentViewIfNeeded: `[implementation]`

(void)	- setTextInputEditingState: `[implementation]`

(void)	- clearTextInputClient `[implementation]`

(void)	- updateConfig: `[implementation]`

(BOOL)	- indirectScribbleInteraction:isElementFocused: `[implementation]`

(void)	- indirectScribbleInteraction:focusElementIfNeeded:referencePoint:completion: `[implementation]`

(BOOL)	- indirectScribbleInteraction:shouldDelayFocusForElement: `[implementation]`

(void)	- indirectScribbleInteraction:willBeginWritingInElement: `[implementation]`

(void)	- indirectScribbleInteraction:didFinishWritingInElement: `[implementation]`

(CGRect)	- indirectScribbleInteraction:frameForElement: `[implementation]`

(void)	- indirectScribbleInteraction:requestElementsInRect:completion: `[implementation]`

(BOOL)	- handlePress: `[implementation]`

(void)	- resignAndRemoveFromSuperview `[implementation]`

(void)	- setEditableTransform: `[implementation]`

(void)	- updateCaretRect: `[implementation]`

(void)	- setEditingState: `[implementation]`

(NSDictionary *)	- editingState `[implementation]`

(void)	- updateEditState `[implementation]`

(void)	- updateEditStateWithDelta: `[implementation]`

(void)	- updateTextAndSelection `[implementation]`

(NSString *)	- textAffinityString `[implementation]`

(void)	- keyDown: `[implementation]`

(void)	- keyUp: `[implementation]`

(BOOL)	- performKeyEquivalent: `[implementation]`

(void)	- flagsChanged: `[implementation]`

(void)	- mouseDown: `[implementation]`

(void)	- mouseUp: `[implementation]`

(void)	- mouseDragged: `[implementation]`

(void)	- rightMouseDown: `[implementation]`

(void)	- rightMouseUp: `[implementation]`

(void)	- rightMouseDragged: `[implementation]`

(void)	- otherMouseDown: `[implementation]`

(void)	- otherMouseUp: `[implementation]`

(void)	- otherMouseDragged: `[implementation]`

(void)	- mouseMoved: `[implementation]`

(void)	- scrollWheel: `[implementation]`

(NSTextInputContext *)	- inputContext `[implementation]`

(void)	- insertTab: `[implementation]`

(void)	- insertText:replacementRange: `[implementation]`

(void)	- doCommandBySelector: `[implementation]`

(void)	- insertNewline: `[implementation]`

(void)	- setMarkedText:selectedRange:replacementRange: `[implementation]`

(void)	- unmarkText `[implementation]`

(NSRange)	- markedRange `[implementation]`

(BOOL)	- hasMarkedText `[implementation]`

(NSAttributedString *)	- attributedSubstringForProposedRange:actualRange: `[implementation]`

(NSArray< NSString * > *)	- validAttributesForMarkedText `[implementation]`

(CGRect)	- screenRectFromFrameworkTransform: `[implementation]`

(NSRect)	- firstRectForCharacterRange:actualRange: `[implementation]`

(NSUInteger)	- characterIndexForPoint: `[implementation]`

Class Methods
(instancetype)	+ NS_UNAVAILABLE

Protected Attributes
	: NSObject <FlutterKeySecondaryResponder

Properties
UIIndirectScribbleInteractionDelegate UIViewController *	viewController

id< FlutterIndirectScribbleDelegate >	indirectScribbleDelegate

NSMutableDictionary< UIScribbleElementIdentifier, NSValue * > *	scribbleElements

FlutterTextField *	client

id< FlutterTextInputDelegate >	textInputDelegate `[implementation]`

NSMutableDictionary< NSString , FlutterTextInputView > *	autofillContext `[implementation]`

FlutterTextInputView *	activeView `[implementation]`

FlutterTextInputViewAccessibilityHider *	inputHider `[implementation]`

UIView *	inputHider `[implementation]`

id< FlutterViewResponder >	viewResponder `[implementation]`

UIView *	keyboardViewContainer `[implementation]`

UIView *	keyboardView `[implementation]`

UIView *	cachedFirstResponder `[implementation]`

CGRect	keyboardRect `[implementation]`

CGFloat	previousPointerYPosition `[implementation]`

CGFloat	pointerYVelocity `[implementation]`

NSTextInputContext *	textInputContext `[implementation]`

FlutterMethodChannel *	channel `[implementation]`

FlutterViewController *	flutterViewController `[implementation]`

BOOL	shown `[implementation]`

uint64_t	previouslyPressedFlags `[implementation]`

FlutterTextAffinity	textAffinity `[implementation]`

NSNumber *	clientID `[implementation]`

NSString *	inputType `[implementation]`

NSString *	inputAction `[implementation]`

BOOL	eventProducedOutput `[implementation]`

BOOL	enableDeltaModel `[implementation]`

NSMutableArray *	pendingSelectors `[implementation]`

NSString *	customRunLoopMode `[implementation]`

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 33 of file FlutterTextInputPlugin.h.

Method Documentation

◆ addToInputParentViewIfNeeded:

- (void) addToInputParentViewIfNeeded: (FlutterTextInputView*) inputView

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                    :(FlutterTextInputView*)inputView {
  if (![inputView isDescendantOfView:_inputHider]) {
    [_inputHider addSubview:inputView];
  }
 
  if (_viewController.view == nil) {
    // If view controller's view has detached from flutter engine, we don't add _inputHider
    // in parent view to fallback and avoid crash.
    // https://github.com/flutter/flutter/issues/106404.
    return;
  }
  UIView* parentView = self.hostView;
  if (_inputHider.superview != parentView) {
    [parentView addSubview:_inputHider];
  }
}

◆ API_AVAILABLE

- (ios(16.0) API_AVAILABLE

◆ attributedSubstringForProposedRange:actualRange:

- (NSAttributedString *) attributedSubstringForProposedRange:	(NSRange)	range
actualRange:	(NSRangePointer)	actualRange

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                                                          :(NSRange)range
                                               actualRange:(NSRangePointer)actualRange {
  if (_activeModel == nullptr) {
    return nil;
  }
  if (actualRange != nil) {
    *actualRange = range;
  }
  NSString* text = [NSString stringWithUTF8String:_activeModel->GetText().c_str()];
  NSString* substring = [text substringWithRange:range];
  return [[NSAttributedString alloc] initWithString:substring attributes:nil];
}

◆ changeInputViewsAutofillVisibility:

- (void) changeInputViewsAutofillVisibility: (BOOL) newVisibility

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                          :(BOOL)newVisibility {
  for (UIView* view in self.textInputViews) {
    if ([view isKindOfClass:[FlutterTextInputView class]]) {
      FlutterTextInputView* inputView = (FlutterTextInputView*)view;
      inputView.isVisibleToAutofill = newVisibility;
    }
  }
}

◆ characterIndexForPoint:

- (NSUInteger) characterIndexForPoint: (NSPoint) point

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                                    :(NSPoint)point {
  // TODO(cbracken): Implement.
  // Note: This function can't easily be implemented under the system-message architecture.
  return 0;
}

◆ cleanUpViewHierarchy:clearText:delayRemoval:

- (void) cleanUpViewHierarchy:	(BOOL)	includeActiveView
clearText:	(BOOL)	clearText
delayRemoval:	(BOOL)	delayRemoval

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                            :(BOOL)includeActiveView
                   clearText:(BOOL)clearText
                delayRemoval:(BOOL)delayRemoval {
  for (UIView* view in self.textInputViews) {
    if ([view isKindOfClass:[FlutterTextInputView class]] &&
        (includeActiveView || view != _activeView)) {
      FlutterTextInputView* inputView = (FlutterTextInputView*)view;
      if (_autofillContext[inputView.autofillId] != view) {
        if (clearText) {
          [inputView replaceRangeLocal:NSMakeRange(0, inputView.text.length) withText:@""];
        }
        if (delayRemoval) {
          [inputView performSelector:@selector(removeFromSuperview) withObject:nil afterDelay:0.1];
        } else {
          [inputView removeFromSuperview];
        }
      }
    }
  }
}

◆ clearTextInputClient

- (void) clearTextInputClient

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                             {
  [_activeView setTextInputClient:0];
  _activeView.frame = CGRectZero;
}

◆ createInputViewWith:

- (FlutterTextInputView *) createInputViewWith: (NSDictionary*) configuration

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                            :(NSDictionary*)configuration {
  NSString* autofillId = AutofillIdFromDictionary(configuration);
  if (autofillId) {
    [_autofillContext removeObjectForKey:autofillId];
  }
  FlutterTextInputView* newView = [[FlutterTextInputView alloc] initWithOwner:self];
  [newView configureWithDictionary:configuration];
  [self addToInputParentViewIfNeeded:newView];
 
  for (NSDictionary* field in configuration[kAssociatedAutofillFields]) {
    NSString* autofillId = AutofillIdFromDictionary(field);
    if (autofillId && AutofillTypeOf(field) == kFlutterAutofillTypeNone) {
      [_autofillContext removeObjectForKey:autofillId];
    }
  }
  return newView;
}

◆ dealloc

- (void) dealloc

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                {
  [self hideTextInput];
}

◆ dismissKeyboardScreenshot

- (void) dismissKeyboardScreenshot

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                  {
  for (UIView* subView in _keyboardViewContainer.subviews) {
    [subView removeFromSuperview];
  }
}

◆ doCommandBySelector:

- (void) doCommandBySelector: (SEL) selector

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                           :(SEL)selector {
  _eventProducedOutput |= selector != NSSelectorFromString(@"noop:");
  if ([self respondsToSelector:selector]) {
    // Note: The more obvious [self performSelector...] doesn't give ARC enough information to
    // handle retain semantics properly. See https://stackoverflow.com/questions/7017281/ for more
    // information.
    IMP imp = [self methodForSelector:selector];
    void (*func)(id, SEL, id) = reinterpret_cast<void (*)(id, SEL, id)>(imp);
    func(self, selector, nil);
  }
 
  if (selector == @selector(insertNewline:)) {
    // Already handled through text insertion (multiline) or action.
    return;
  }
 
  // Group multiple selectors received within a single run loop turn so that
  // the framework can process them in single microtask.
  NSString* name = NSStringFromSelector(selector);
  if (_pendingSelectors == nil) {
    _pendingSelectors = [NSMutableArray array];
  }
  [_pendingSelectors addObject:name];
 
  if (_pendingSelectors.count == 1) {
    __weak NSMutableArray* selectors = _pendingSelectors;
    __weak FlutterMethodChannel* channel = _channel;
    __weak NSNumber* clientID = self.clientID;
 
    CFStringRef runLoopMode = self.customRunLoopMode != nil
                                  ? (__bridge CFStringRef)self.customRunLoopMode
                                  : kCFRunLoopCommonModes;
 
    CFRunLoopPerformBlock(CFRunLoopGetMain(), runLoopMode, ^{
      if (selectors.count > 0) {
        [channel invokeMethod:kPerformSelectors arguments:@[ clientID, selectors ]];
        [selectors removeAllObjects];
      }
    });
  }
}

◆ editingState

- (NSDictionary *) editingState

implementation

Provided by category FlutterTextInputPlugin(TestMethods).

Definition at line 339 of file FlutterTextInputPlugin.mm.

                              {
  if (_activeModel == nullptr) {
    return nil;
  }
 
  NSString* const textAffinity = [self textAffinityString];
 
  int composingBase = _activeModel->composing() ? _activeModel->composing_range().base() : -1;
  int composingExtent = _activeModel->composing() ? _activeModel->composing_range().extent() : -1;
 
  return @{
    kSelectionBaseKey : @(_activeModel->selection().base()),
    kSelectionExtentKey : @(_activeModel->selection().extent()),
    kSelectionAffinityKey : textAffinity,
    kSelectionIsDirectionalKey : @NO,
    kComposingBaseKey : @(composingBase),
    kComposingExtentKey : @(composingExtent),
    kTextKey : [NSString stringWithUTF8String:_activeModel->GetText().c_str()] ?: [NSNull null],
  };
}

◆ enableActiveViewAccessibility

- (void) enableActiveViewAccessibility

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                      {
  if (_activeView.isFirstResponder) {
    _activeView.accessibilityEnabled = YES;
  }
  [self removeEnableFlutterTextInputViewAccessibilityTimer];
}

◆ firstRectForCharacterRange:actualRange:

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

implementation

Provided by category FlutterTextInputPlugin(TestMethods).

Definition at line 339 of file FlutterTextInputPlugin.mm.

                                    :(NSRange)range actualRange:(NSRangePointer)actualRange {
  // This only determines position of caret instead of any arbitrary range, but it's enough
  // to properly position accent selection popup
  return !self.flutterViewController.viewLoaded || CGRectEqualToRect(_caretRect, CGRectNull)
             ? CGRectZero
             : [self screenRectFromFrameworkTransform:_caretRect];
}

◆ flagsChanged:

- (void) flagsChanged: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                    :(NSEvent*)event {
  [self.flutterViewController flagsChanged:event];
}

◆ getOrCreateAutofillableView:isPasswordAutofill:

- (FlutterTextInputView *) getOrCreateAutofillableView:	(NSDictionary*)	field
isPasswordAutofill:	(BOOL)	needsPasswordAutofill

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                                    :(NSDictionary*)field
                                  isPasswordAutofill:(BOOL)needsPasswordAutofill {
  NSString* autofillId = AutofillIdFromDictionary(field);
  FlutterTextInputView* inputView = _autofillContext[autofillId];
  if (!inputView) {
    inputView =
        needsPasswordAutofill ? [FlutterSecureTextInputView alloc] : [FlutterTextInputView alloc];
    inputView = [inputView initWithOwner:self];
    [self addToInputParentViewIfNeeded:inputView];
  }
 
  [inputView configureWithDictionary:field];
  return inputView;
}

◆ handleKeyboardWillShow:

- (void) handleKeyboardWillShow: (NSNotification*) notification

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                              :(NSNotification*)notification {
  NSDictionary* keyboardInfo = [notification userInfo];
  NSValue* keyboardFrameEnd = [keyboardInfo valueForKey:UIKeyboardFrameEndUserInfoKey];
  _keyboardRect = [keyboardFrameEnd CGRectValue];
}

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

                      :(NSEvent*)event {
  if (event.type == NSEventTypeKeyUp ||
      (event.type == NSEventTypeFlagsChanged && event.modifierFlags < _previouslyPressedFlags)) {
    return NO;
  }
  _previouslyPressedFlags = event.modifierFlags;
  if (!_shown) {
    return NO;
  }
 
  _eventProducedOutput = NO;
  BOOL res = [_textInputContext handleEvent:event];
  // NSTextInputContext#handleEvent returns YES if the context handles the event. One of the reasons
  // the event is handled is because it's a key equivalent. But a key equivalent might produce a
  // text command (indicated by calling doCommandBySelector) or might not (for example, Cmd+Q). In
  // the latter case, this command somehow has not been executed yet and Flutter must dispatch it to
  // the next responder. See https://github.com/flutter/flutter/issues/106354 .
  // The event is also not redispatched if there is IME composition active, because it might be
  // handled by the IME. See https://github.com/flutter/flutter/issues/134699
 
  // both NSEventModifierFlagNumericPad and NSEventModifierFlagFunction are set for arrow keys.
  bool is_navigation = event.modifierFlags & NSEventModifierFlagFunction &&
                       event.modifierFlags & NSEventModifierFlagNumericPad;
  bool is_navigation_in_ime = is_navigation && self.hasMarkedText;
 
  if (event.isKeyEquivalent && !is_navigation_in_ime && !_eventProducedOutput) {
    return NO;
  }
  return res;
}

◆ handleMethodCall:result:

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

Handles a Flutter system message on the text input channel.

Provided by category FlutterTextInputPlugin(TestMethods).

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                        :(FlutterMethodCall*)call result:(FlutterResult)result {
  NSString* method = call.method;
  id args = call.arguments;
  if ([method isEqualToString:kShowMethod]) {
    [self showTextInput];
    result(nil);
  } else if ([method isEqualToString:kHideMethod]) {
    [self hideTextInput];
    result(nil);
  } else if ([method isEqualToString:kSetClientMethod]) {
    [self setTextInputClient:[args[0] intValue] withConfiguration:args[1]];
    result(nil);
  } else if ([method isEqualToString:kSetPlatformViewClientMethod]) {
    // This method call has a `platformViewId` argument, but we do not need it for iOS for now.
    [self setPlatformViewTextInputClient];
    result(nil);
  } else if ([method isEqualToString:kSetEditingStateMethod]) {
    [self setTextInputEditingState:args];
    result(nil);
  } else if ([method isEqualToString:kClearClientMethod]) {
    [self clearTextInputClient];
    result(nil);
  } else if ([method isEqualToString:kSetEditableSizeAndTransformMethod]) {
    [self setEditableSizeAndTransform:args];
    result(nil);
  } else if ([method isEqualToString:kSetMarkedTextRectMethod]) {
    [self updateMarkedRect:args];
    result(nil);
  } else if ([method isEqualToString:kFinishAutofillContextMethod]) {
    [self triggerAutofillSave:[args boolValue]];
    result(nil);
    // TODO(justinmc): Remove the TextInput method constant when the framework has
    // finished transitioning to using the Scribble channel.
    // https://github.com/flutter/flutter/pull/104128
  } else if ([method isEqualToString:kDeprecatedSetSelectionRectsMethod]) {
    [self setSelectionRects:args];
    result(nil);
  } else if ([method isEqualToString:kSetSelectionRectsMethod]) {
    [self setSelectionRects:args];
    result(nil);
  } else if ([method isEqualToString:kStartLiveTextInputMethod]) {
    [self startLiveTextInput];
    result(nil);
  } else if ([method isEqualToString:kUpdateConfigMethod]) {
    [self updateConfig:args];
    result(nil);
  } else if ([method isEqualToString:kOnInteractiveKeyboardPointerMoveMethod]) {
    CGFloat pointerY = (CGFloat)[args[@"pointerY"] doubleValue];
    [self handlePointerMove:pointerY];
    result(nil);
  } else if ([method isEqualToString:kOnInteractiveKeyboardPointerUpMethod]) {
    CGFloat pointerY = (CGFloat)[args[@"pointerY"] doubleValue];
    [self handlePointerUp:pointerY];
    result(nil);
  } else {
    result(FlutterMethodNotImplemented);
  }
}

◆ handlePointerMove:

- (void) handlePointerMove: (CGFloat) pointerY

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                         :(CGFloat)pointerY {
  // View must be loaded at this point.
  UIScreen* screen = _viewController.flutterScreenIfViewLoaded;
  CGFloat screenHeight = screen.bounds.size.height;
  CGFloat keyboardHeight = _keyboardRect.size.height;
  if (screenHeight - keyboardHeight <= pointerY) {
    // If the pointer is within the bounds of the keyboard.
    if (_keyboardView.superview == nil) {
      // If no screenshot has been taken.
      [self takeKeyboardScreenshotAndDisplay];
      [self hideKeyboardWithoutAnimationAndAvoidCursorDismissUpdate];
    } else {
      [self setKeyboardContainerHeight:pointerY];
      _pointerYVelocity = _previousPointerYPosition - pointerY;
    }
  } else {
    if (_keyboardView.superview != nil) {
      // Keeps keyboard at proper height.
      _keyboardViewContainer.frame = _keyboardRect;
      _pointerYVelocity = _previousPointerYPosition - pointerY;
    }
  }
  _previousPointerYPosition = pointerY;
}

◆ handlePointerUp:

- (void) handlePointerUp: (CGFloat) pointerY

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                       :(CGFloat)pointerY {
  if (_keyboardView.superview != nil) {
    // Done to avoid the issue of a pointer up done without a screenshot
    // View must be loaded at this point.
    UIScreen* screen = _viewController.flutterScreenIfViewLoaded;
    CGFloat screenHeight = screen.bounds.size.height;
    CGFloat keyboardHeight = _keyboardRect.size.height;
    // Negative velocity indicates a downward movement
    BOOL shouldDismissKeyboardBasedOnVelocity = _pointerYVelocity < 0;
    [UIView animateWithDuration:kKeyboardAnimationTimeToCompleteion
        animations:^{
          double keyboardDestination =
              shouldDismissKeyboardBasedOnVelocity ? screenHeight : screenHeight - keyboardHeight;
          _keyboardViewContainer.frame = CGRectMake(
              0, keyboardDestination, _viewController.flutterScreenIfViewLoaded.bounds.size.width,
              _keyboardViewContainer.frame.size.height);
        }
        completion:^(BOOL finished) {
          if (shouldDismissKeyboardBasedOnVelocity) {
            [self.textInputDelegate flutterTextInputView:self.activeView
                didResignFirstResponderWithTextInputClient:self.activeView.textInputClient];
            [self dismissKeyboardScreenshot];
          } else {
            [self showKeyboardAndRemoveScreenshot];
          }
        }];
  }
}

◆ handlePress:

- (BOOL) handlePress: (ios(13.4)) API_AVAILABLE

implementation

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

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                   :(nonnull FlutterUIPressProxy*)press API_AVAILABLE(ios(13.4)) {
  return NO;
}

◆ hasMarkedText

- (BOOL) hasMarkedText

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                      {
  return _activeModel != nullptr && _activeModel->composing_range().length() > 0;
}

◆ hideEditMenu

- (void) hideEditMenu

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                     {
  [self.activeView hideEditMenu];
}

◆ hideKeyboardWithoutAnimationAndAvoidCursorDismissUpdate

- (void) hideKeyboardWithoutAnimationAndAvoidCursorDismissUpdate

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                                                {
  [UIView setAnimationsEnabled:NO];
  _cachedFirstResponder = UIApplication.sharedApplication.keyWindow.flutterFirstResponder;
  _activeView.preventCursorDismissWhenResignFirstResponder = YES;
  [_cachedFirstResponder resignFirstResponder];
  _activeView.preventCursorDismissWhenResignFirstResponder = NO;
  [UIView setAnimationsEnabled:YES];
}

◆ hideTextInput

- (void) hideTextInput

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                      {
  [self removeEnableFlutterTextInputViewAccessibilityTimer];
  _activeView.accessibilityEnabled = NO;
  [_activeView resignFirstResponder];
  [_activeView removeFromSuperview];
  [_inputHider removeFromSuperview];
}

◆ hostView

- (UIView *) hostView

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                    {
  UIView* host = _viewController.view;
  NSAssert(host != nullptr,
           @"The application must have a host view since the keyboard client "
           @"must be part of the responder chain to function. The host view controller is %@",
           _viewController);
  return host;
}

◆ indirectScribbleInteraction:didFinishWritingInElement:

- (void) indirectScribbleInteraction:	(UIIndirectScribbleInteraction*)	interaction
didFinishWritingInElement:	(ios(14.0))	API_AVAILABLE

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                   :(UIIndirectScribbleInteraction*)interaction
          didFinishWritingInElement:(UIScribbleElementIdentifier)elementIdentifier
    API_AVAILABLE(ios(14.0)) {
}

◆ indirectScribbleInteraction:focusElementIfNeeded:referencePoint:completion:

- (void) indirectScribbleInteraction:	(UIIndirectScribbleInteraction*)	interaction
focusElementIfNeeded:	(UIScribbleElementIdentifier)	elementIdentifier
referencePoint:	(CGPoint)	focusReferencePoint
completion:	(ios(14.0))	API_AVAILABLE

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                   :(UIIndirectScribbleInteraction*)interaction
               focusElementIfNeeded:(UIScribbleElementIdentifier)elementIdentifier
                     referencePoint:(CGPoint)focusReferencePoint
                         completion:(void (^)(UIResponder<UITextInput>* focusedInput))completion
    API_AVAILABLE(ios(14.0)) {
  _activeView.scribbleFocusStatus = FlutterScribbleFocusStatusFocusing;
  [_indirectScribbleDelegate flutterTextInputPlugin:self
                                       focusElement:elementIdentifier
                                            atPoint:focusReferencePoint
                                             result:^(id _Nullable result) {
                                               _activeView.scribbleFocusStatus =
                                                   FlutterScribbleFocusStatusFocused;
                                               completion(_activeView);
                                             }];
}

◆ indirectScribbleInteraction:frameForElement:

- (CGRect) indirectScribbleInteraction:	(UIIndirectScribbleInteraction*)	interaction
frameForElement:	(ios(14.0))	API_AVAILABLE

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                     :(UIIndirectScribbleInteraction*)interaction
                      frameForElement:(UIScribbleElementIdentifier)elementIdentifier
    API_AVAILABLE(ios(14.0)) {
  NSValue* elementValue = [_scribbleElements objectForKey:elementIdentifier];
  if (elementValue == nil) {
    return CGRectZero;
  }
  return [elementValue CGRectValue];
}

◆ indirectScribbleInteraction:isElementFocused:

- (BOOL) indirectScribbleInteraction:	(UIIndirectScribbleInteraction*)	interaction
isElementFocused:	(ios(14.0))	API_AVAILABLE

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                   :(UIIndirectScribbleInteraction*)interaction
                   isElementFocused:(UIScribbleElementIdentifier)elementIdentifier
    API_AVAILABLE(ios(14.0)) {
  return _activeView.scribbleFocusStatus == FlutterScribbleFocusStatusFocused;
}

◆ indirectScribbleInteraction:requestElementsInRect:completion:

- (void) indirectScribbleInteraction:	(UIIndirectScribbleInteraction*)	interaction
requestElementsInRect:	(CGRect)	rect
completion:	(ios(14.0))	API_AVAILABLE

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                   :(UIIndirectScribbleInteraction*)interaction
              requestElementsInRect:(CGRect)rect
                         completion:
                             (void (^)(NSArray<UIScribbleElementIdentifier>* elements))completion
    API_AVAILABLE(ios(14.0)) {
  [_indirectScribbleDelegate
      flutterTextInputPlugin:self
       requestElementsInRect:rect
                      result:^(id _Nullable result) {
                        NSMutableArray<UIScribbleElementIdentifier>* elements =
                            [[NSMutableArray alloc] init];
                        if ([result isKindOfClass:[NSArray class]]) {
                          for (NSArray* elementArray in result) {
                            [elements addObject:elementArray[0]];
                            [_scribbleElements
                                setObject:[NSValue
                                              valueWithCGRect:CGRectMake(
                                                                  [elementArray[1] floatValue],
                                                                  [elementArray[2] floatValue],
                                                                  [elementArray[3] floatValue],
                                                                  [elementArray[4] floatValue])]
                                   forKey:elementArray[0]];
                          }
                        }
                        completion(elements);
                      }];
}

◆ indirectScribbleInteraction:shouldDelayFocusForElement:

- (BOOL) indirectScribbleInteraction:	(UIIndirectScribbleInteraction*)	interaction
shouldDelayFocusForElement:	(ios(14.0))	API_AVAILABLE

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                   :(UIIndirectScribbleInteraction*)interaction
         shouldDelayFocusForElement:(UIScribbleElementIdentifier)elementIdentifier
    API_AVAILABLE(ios(14.0)) {
  return NO;
}

◆ indirectScribbleInteraction:willBeginWritingInElement:

- (void) indirectScribbleInteraction:	(UIIndirectScribbleInteraction*)	interaction
willBeginWritingInElement:	(ios(14.0))	API_AVAILABLE

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                   :(UIIndirectScribbleInteraction*)interaction
          willBeginWritingInElement:(UIScribbleElementIdentifier)elementIdentifier
    API_AVAILABLE(ios(14.0)) {
}

◆ initWithDelegate:

- (instancetype) initWithDelegate: (id<FlutterTextInputDelegate>) NS_DESIGNATED_INITIALIZER

Initial value:

{

NSTimer* _enableFlutterTextInputViewAccessibilityTimer

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                :(id<FlutterTextInputDelegate>)textInputDelegate {
  self = [super init];
  if (self) {
    // `_textInputDelegate` is a weak reference because it should retain FlutterTextInputPlugin.
    _textInputDelegate = textInputDelegate;
    _autofillContext = [[NSMutableDictionary alloc] init];
    _inputHider = [[FlutterTextInputViewAccessibilityHider alloc] init];
    _scribbleElements = [[NSMutableDictionary alloc] init];
    _keyboardViewContainer = [[UIView alloc] init];
 
    [[NSNotificationCenter defaultCenter] addObserver:self
                                             selector:@selector(handleKeyboardWillShow:)
                                                 name:UIKeyboardWillShowNotification
                                               object:nil];
  }
 
  return self;
}

◆ initWithViewController:

- (instancetype) initWithViewController: (FlutterViewController*) viewController

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

Definition at line 339 of file FlutterTextInputPlugin.mm.

                                      :(FlutterViewController*)viewController {
  // The view needs an empty frame otherwise it is visible on dark background.
  // https://github.com/flutter/flutter/issues/118504
  self = [super initWithFrame:NSZeroRect];
  self.clipsToBounds = YES;
  if (self != nil) {
    _flutterViewController = viewController;
    _channel = [FlutterMethodChannel methodChannelWithName:kTextInputChannel
                                           binaryMessenger:viewController.engine.binaryMessenger
                                                     codec:[FlutterJSONMethodCodec sharedInstance]];
    _shown = FALSE;
    // NSTextView does not support _weak reference, so this class has to
    // use __unsafe_unretained and manage the reference by itself.
    //
    // Since the dealloc removes the handler, the pointer should
    // be valid if the handler is ever called.
    __unsafe_unretained FlutterTextInputPlugin* unsafeSelf = self;
    [_channel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
      [unsafeSelf handleMethodCall:call result:result];
    }];
    _textInputContext = [[NSTextInputContext alloc] initWithClient:unsafeSelf];
    _previouslyPressedFlags = 0;
 
    // Initialize with the zero matrix which is not
    // an affine transform.
    _editableTransform = CATransform3D();
    _caretRect = CGRectNull;
  }
  return self;
}

◆ inputContext

- (NSTextInputContext *) inputContext

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                                    {
  return _textInputContext;
}

◆ insertNewline:

- (void) insertNewline: (id) sender

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                     :(id)sender {
  if (_activeModel == nullptr) {
    return;
  }
  if (_activeModel->composing()) {
    _activeModel->CommitComposing();
    _activeModel->EndComposing();
  }
  if ([self.inputType isEqualToString:kMultilineInputType] &&
      [self.inputAction isEqualToString:kInputActionNewline]) {
    [self insertText:@"\n" replacementRange:self.selectedRange];
  }
  [_channel invokeMethod:kPerformAction arguments:@[ self.clientID, self.inputAction ]];
}

◆ insertTab:

- (void) insertTab: (id) sender

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                 :(id)sender {
  // Implementing insertTab: makes AppKit send tab as command, instead of
  // insertText with '\t'.
}

◆ insertText:replacementRange:

- (void) insertText:	(id)	string
replacementRange:	(NSRange)	range

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                  :(id)string replacementRange:(NSRange)range {
  if (_activeModel == nullptr) {
    return;
  }
 
  _eventProducedOutput |= true;
 
  if (range.location != NSNotFound) {
    // The selected range can actually have negative numbers, since it can start
    // at the end of the range if the user selected the text going backwards.
    // Cast to a signed type to determine whether or not the selection is reversed.
    long signedLength = static_cast<long>(range.length);
    long location = range.location;
    long textLength = _activeModel->text_range().end();
 
    size_t base = std::clamp(location, 0L, textLength);
    size_t extent = std::clamp(location + signedLength, 0L, textLength);
 
    _activeModel->SetSelection(flutter::TextRange(base, extent));
  }
 
  flutter::TextRange oldSelection = _activeModel->selection();
  flutter::TextRange composingBeforeChange = _activeModel->composing_range();
  flutter::TextRange replacedRange(-1, -1);
 
  std::string textBeforeChange = _activeModel->GetText().c_str();
  std::string utf8String = [string UTF8String];
  _activeModel->AddText(utf8String);
  if (_activeModel->composing()) {
    replacedRange = composingBeforeChange;
    _activeModel->CommitComposing();
    _activeModel->EndComposing();
  } else {
    replacedRange = range.location == NSNotFound
                        ? flutter::TextRange(oldSelection.base(), oldSelection.extent())
                        : flutter::TextRange(range.location, range.location + range.length);
  }
  if (_enableDeltaModel) {
    [self updateEditStateWithDelta:flutter::TextEditingDelta(textBeforeChange, replacedRange,
                                                             utf8String)];
  } else {
    [self updateEditState];
  }
}

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

                         {
  if (!self.flutterViewController.viewLoaded) {
    return false;
  }
  return [self.flutterViewController.view.window firstResponder] == self;
}

◆ keyDown:

- (void) keyDown: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

               :(NSEvent*)event {
  [self.flutterViewController keyDown:event];
}

◆ keyUp:

- (void) keyUp: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

             :(NSEvent*)event {
  [self.flutterViewController keyUp:event];
}

◆ markedRange

- (NSRange) markedRange

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                       {
  if (_activeModel == nullptr) {
    return NSMakeRange(NSNotFound, 0);
  }
  return NSMakeRange(
      _activeModel->composing_range().base(),
      _activeModel->composing_range().extent() - _activeModel->composing_range().base());
}

◆ mouseDown:

- (void) mouseDown: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                 :(NSEvent*)event {
  [self.flutterViewController mouseDown:event];
}

◆ mouseDragged:

- (void) mouseDragged: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                    :(NSEvent*)event {
  [self.flutterViewController mouseDragged:event];
}

◆ mouseMoved:

- (void) mouseMoved: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                  :(NSEvent*)event {
  [self.flutterViewController mouseMoved:event];
}

◆ mouseUp:

- (void) mouseUp: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

               :(NSEvent*)event {
  [self.flutterViewController mouseUp:event];
}

◆ NS_UNAVAILABLE [1/2]

- (instancetype) NS_UNAVAILABLE

◆ NS_UNAVAILABLE [2/2]

+ (instancetype) NS_UNAVAILABLE

◆ otherMouseDown:

- (void) otherMouseDown: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                      :(NSEvent*)event {
  [self.flutterViewController otherMouseDown:event];
}

◆ otherMouseDragged:

- (void) otherMouseDragged: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                         :(NSEvent*)event {
  [self.flutterViewController otherMouseDragged:event];
}

◆ otherMouseUp:

- (void) otherMouseUp: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                    :(NSEvent*)event {
  [self.flutterViewController otherMouseUp:event];
}

◆ performKeyEquivalent:

- (BOOL) performKeyEquivalent: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                            :(NSEvent*)event {
  if ([_flutterViewController isDispatchingKeyEvent:event]) {
    // When NSWindow is nextResponder, keyboard manager will send to it
    // unhandled events (through [NSWindow keyDown:]). If event has both
    // control and cmd modifiers set (i.e. cmd+control+space - emoji picker)
    // NSWindow will then send this event as performKeyEquivalent: to first
    // responder, which is FlutterTextInputPlugin. If that's the case, the
    // plugin must not handle the event, otherwise the emoji picker would not
    // work (due to first responder returning YES from performKeyEquivalent:)
    // and there would be endless loop, because FlutterViewController will
    // send the event back to [keyboardManager handleEvent:].
    return NO;
  }
  [event markAsKeyEquivalent];
  [self.flutterViewController keyDown:event];
  return YES;
}

◆ removeEnableFlutterTextInputViewAccessibilityTimer

- (void) removeEnableFlutterTextInputViewAccessibilityTimer

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                                           {
  if (_enableFlutterTextInputViewAccessibilityTimer) {
    [_enableFlutterTextInputViewAccessibilityTimer invalidate];
    _enableFlutterTextInputViewAccessibilityTimer = nil;
  }
}

◆ resetAllClientIds

- (void) resetAllClientIds

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                          {
  for (UIView* view in self.textInputViews) {
    if ([view isKindOfClass:[FlutterTextInputView class]]) {
      FlutterTextInputView* inputView = (FlutterTextInputView*)view;
      [inputView setTextInputClient:0];
    }
  }
}

◆ resetViewResponder

- (void) resetViewResponder

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                           {
  _viewResponder = nil;
}

◆ resignAndRemoveFromSuperview

- (void) resignAndRemoveFromSuperview

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                                     {
  if (self.superview != nil) {
    [self.window makeFirstResponder:_flutterViewController.flutterView];
    [self removeFromSuperview];
  }
}

◆ rightMouseDown:

- (void) rightMouseDown: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                      :(NSEvent*)event {
  [self.flutterViewController rightMouseDown:event];
}

◆ rightMouseDragged:

- (void) rightMouseDragged: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                         :(NSEvent*)event {
  [self.flutterViewController rightMouseDragged:event];
}

◆ rightMouseUp:

- (void) rightMouseUp: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                    :(NSEvent*)event {
  [self.flutterViewController rightMouseUp:event];
}

◆ screenRectFromFrameworkTransform:

- (CGRect) screenRectFromFrameworkTransform: (CGRect) incomingRect

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                                          :(CGRect)incomingRect {
  CGPoint points[] = {
      incomingRect.origin,
      CGPointMake(incomingRect.origin.x, incomingRect.origin.y + incomingRect.size.height),
      CGPointMake(incomingRect.origin.x + incomingRect.size.width, incomingRect.origin.y),
      CGPointMake(incomingRect.origin.x + incomingRect.size.width,
                  incomingRect.origin.y + incomingRect.size.height)};
 
  CGPoint origin = CGPointMake(CGFLOAT_MAX, CGFLOAT_MAX);
  CGPoint farthest = CGPointMake(-CGFLOAT_MAX, -CGFLOAT_MAX);
 
  for (int i = 0; i < 4; i++) {
    const CGPoint point = points[i];
 
    CGFloat x = _editableTransform.m11 * point.x + _editableTransform.m21 * point.y +
                _editableTransform.m41;
    CGFloat y = _editableTransform.m12 * point.x + _editableTransform.m22 * point.y +
                _editableTransform.m42;
 
    const CGFloat w = _editableTransform.m14 * point.x + _editableTransform.m24 * point.y +
                      _editableTransform.m44;
 
    if (w == 0.0) {
      return CGRectZero;
    } else if (w != 1.0) {
      x /= w;
      y /= w;
    }
 
    origin.x = MIN(origin.x, x);
    origin.y = MIN(origin.y, y);
    farthest.x = MAX(farthest.x, x);
    farthest.y = MAX(farthest.y, y);
  }
 
  const NSView* fromView = self.flutterViewController.flutterView;
  const CGRect rectInWindow = [fromView
      convertRect:CGRectMake(origin.x, origin.y, farthest.x - origin.x, farthest.y - origin.y)
           toView:nil];
  NSWindow* window = fromView.window;
  return window ? [window convertRectToScreen:rectInWindow] : rectInWindow;
}

◆ scrollWheel:

- (void) scrollWheel: (NSEvent*) event

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                   :(NSEvent*)event {
  [self.flutterViewController scrollWheel:event];
}

◆ setEditableSizeAndTransform:

- (void) setEditableSizeAndTransform: (NSDictionary*) dictionary

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                   :(NSDictionary*)dictionary {
  NSArray* transform = dictionary[@"transform"];
  [_activeView setEditableTransform:transform];
  const int leftIndex = 12;
  const int topIndex = 13;
  if ([_activeView isScribbleAvailable]) {
    // This is necessary to set up where the scribble interactable element will be.
    _inputHider.frame =
        CGRectMake([transform[leftIndex] intValue], [transform[topIndex] intValue],
                   [dictionary[@"width"] intValue], [dictionary[@"height"] intValue]);
    _activeView.frame =
        CGRectMake(0, 0, [dictionary[@"width"] intValue], [dictionary[@"height"] intValue]);
    _activeView.tintColor = [UIColor clearColor];
  } else {
    // TODO(hellohuanlin): Also need to handle iOS 16 case, where the auto-correction highlight does
    // not match the size of text.
    // See https://github.com/flutter/flutter/issues/131695
    if (@available(iOS 17, *)) {
      // Move auto-correction highlight to overlap with the actual text.
      // This is to fix an issue where the system auto-correction highlight is displayed at
      // the top left corner of the screen on iOS 17+.
      // This problem also happens on iOS 16, but the size of highlight does not match the text.
      // See https://github.com/flutter/flutter/issues/131695
      // TODO(hellohuanlin): Investigate if we can use non-zero size.
      _inputHider.frame =
          CGRectMake([transform[leftIndex] intValue], [transform[topIndex] intValue], 0, 0);
    }
  }
}

◆ setEditableTransform:

- (void) setEditableTransform: (NSArray*) matrix

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                            :(NSArray*)matrix {
  CATransform3D* transform = &_editableTransform;
 
  transform->m11 = [matrix[0] doubleValue];
  transform->m12 = [matrix[1] doubleValue];
  transform->m13 = [matrix[2] doubleValue];
  transform->m14 = [matrix[3] doubleValue];
 
  transform->m21 = [matrix[4] doubleValue];
  transform->m22 = [matrix[5] doubleValue];
  transform->m23 = [matrix[6] doubleValue];
  transform->m24 = [matrix[7] doubleValue];
 
  transform->m31 = [matrix[8] doubleValue];
  transform->m32 = [matrix[9] doubleValue];
  transform->m33 = [matrix[10] doubleValue];
  transform->m34 = [matrix[11] doubleValue];
 
  transform->m41 = [matrix[12] doubleValue];
  transform->m42 = [matrix[13] doubleValue];
  transform->m43 = [matrix[14] doubleValue];
  transform->m44 = [matrix[15] doubleValue];
}

◆ setEditingState:

- (void) setEditingState: (NSDictionary *) state

implementation

Updates the text input model with state received from the framework via the TextInput.setEditingState message.

Definition at line 339 of file FlutterTextInputPlugin.mm.

                       :(NSDictionary*)state {
  NSString* selectionAffinity = state[kSelectionAffinityKey];
  if (selectionAffinity != nil) {
    _textAffinity = [selectionAffinity isEqualToString:kTextAffinityUpstream]
                        ? kFlutterTextAffinityUpstream
                        : kFlutterTextAffinityDownstream;
  }
 
  NSString* text = state[kTextKey];
 
  flutter::TextRange selected_range = RangeFromBaseExtent(
      state[kSelectionBaseKey], state[kSelectionExtentKey], _activeModel->selection());
  _activeModel->SetSelection(selected_range);
 
  flutter::TextRange composing_range = RangeFromBaseExtent(
      state[kComposingBaseKey], state[kComposingExtentKey], _activeModel->composing_range());
 
  const bool wasComposing = _activeModel->composing();
  _activeModel->SetText([text UTF8String], selected_range, composing_range);
  if (composing_range.collapsed() && wasComposing) {
    [_textInputContext discardMarkedText];
  }
  [_client startEditing];
 
  [self updateTextAndSelection];
}

◆ setKeyboardContainerHeight:

- (void) setKeyboardContainerHeight: (CGFloat) pointerY

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                  :(CGFloat)pointerY {
  CGRect frameRect = _keyboardRect;
  frameRect.origin.y = pointerY;
  _keyboardViewContainer.frame = frameRect;
}

◆ setMarkedText:selectedRange:replacementRange:

- (void) setMarkedText:	(id)	string
selectedRange:	(NSRange)	selectedRange
replacementRange:	(NSRange)	replacementRange

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                     :(id)string
        selectedRange:(NSRange)selectedRange
     replacementRange:(NSRange)replacementRange {
  if (_activeModel == nullptr) {
    return;
  }
  std::string textBeforeChange = _activeModel->GetText().c_str();
  if (!_activeModel->composing()) {
    _activeModel->BeginComposing();
  }
 
  if (replacementRange.location != NSNotFound) {
    // According to the NSTextInputClient documentation replacementRange is
    // computed from the beginning of the marked text. That doesn't seem to be
    // the case, because in situations where the replacementRange is actually
    // specified (i.e. when switching between characters equivalent after long
    // key press) the replacementRange is provided while there is no composition.
    _activeModel->SetComposingRange(
        flutter::TextRange(replacementRange.location,
                           replacementRange.location + replacementRange.length),
        0);
  }
 
  flutter::TextRange composingBeforeChange = _activeModel->composing_range();
  flutter::TextRange selectionBeforeChange = _activeModel->selection();
 
  // Input string may be NSString or NSAttributedString.
  BOOL isAttributedString = [string isKindOfClass:[NSAttributedString class]];
  const NSString* rawString = isAttributedString ? [string string] : string;
  _activeModel->UpdateComposingText(
      (const char16_t*)[rawString cStringUsingEncoding:NSUTF16StringEncoding],
      flutter::TextRange(selectedRange.location, selectedRange.location + selectedRange.length));
 
  if (_enableDeltaModel) {
    std::string marked_text = [rawString UTF8String];
    [self updateEditStateWithDelta:flutter::TextEditingDelta(textBeforeChange,
                                                             selectionBeforeChange.collapsed()
                                                                 ? composingBeforeChange
                                                                 : selectionBeforeChange,
                                                             marked_text)];
  } else {
    [self updateEditState];
  }
}

◆ setPlatformViewTextInputClient

- (void) setPlatformViewTextInputClient

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                       {
  // No need to track the platformViewID (unlike in Android). When a platform view
  // becomes the first responder, simply hide this dummy text input view (`_activeView`)
  // for the previously focused widget.
  [self removeEnableFlutterTextInputViewAccessibilityTimer];
  _activeView.accessibilityEnabled = NO;
  [_activeView removeFromSuperview];
  [_inputHider removeFromSuperview];
}

◆ setSelectionRects:

- (void) setSelectionRects: (NSArray*) encodedRects

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                         :(NSArray*)encodedRects {
  NSMutableArray<FlutterTextSelectionRect*>* rectsAsRect =
      [[NSMutableArray alloc] initWithCapacity:[encodedRects count]];
  for (NSUInteger i = 0; i < [encodedRects count]; i++) {
    NSArray<NSNumber*>* encodedRect = encodedRects[i];
    [rectsAsRect addObject:[FlutterTextSelectionRect
                               selectionRectWithRect:CGRectMake([encodedRect[0] floatValue],
                                                                [encodedRect[1] floatValue],
                                                                [encodedRect[2] floatValue],
                                                                [encodedRect[3] floatValue])
                                            position:[encodedRect[4] unsignedIntegerValue]
                                    writingDirection:[encodedRect[5] unsignedIntegerValue] == 1
                                                         ? NSWritingDirectionLeftToRight
                                                         : NSWritingDirectionRightToLeft]];
  }
 
  // TODO(hellohuanlin): Investigate why notifying the text input system about text changes (via
  // textWillChange and textDidChange APIs) causes a bug where we cannot enter text with IME
  // keyboards. Issue: https://github.com/flutter/flutter/issues/133908
  _activeView.selectionRects = rectsAsRect;
}

◆ setTextInputClient:withConfiguration:

- (void) setTextInputClient:	(int)	client
withConfiguration:	(NSDictionary*)	configuration

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                          :(int)client withConfiguration:(NSDictionary*)configuration {
  [self resetAllClientIds];
  // Hide all input views from autofill, only make those in the new configuration visible
  // to autofill.
  [self changeInputViewsAutofillVisibility:NO];
 
  // Update the current active view.
  switch (AutofillTypeOf(configuration)) {
    case kFlutterAutofillTypeNone:
      self.activeView = [self createInputViewWith:configuration];
      break;
    case kFlutterAutofillTypeRegular:
      // If the group does not involve password autofill, only install the
      // input view that's being focused.
      self.activeView = [self updateAndShowAutofillViews:nil
                                            focusedField:configuration
                                       isPasswordRelated:NO];
      break;
    case kFlutterAutofillTypePassword:
      self.activeView = [self updateAndShowAutofillViews:configuration[kAssociatedAutofillFields]
                                            focusedField:configuration
                                       isPasswordRelated:YES];
      break;
  }
  [_activeView setTextInputClient:client];
  [_activeView reloadInputViews];
 
  // Clean up views that no longer need to be in the view hierarchy, according to
  // the current autofill context. The "garbage" input views are already made
  // invisible to autofill and they can't `becomeFirstResponder`, we only remove
  // them to free up resources and reduce the number of input views in the view
  // hierarchy.
  //
  // The garbage views are decommissioned immediately, but the removeFromSuperview
  // call is scheduled on the runloop and delayed by 0.1s so we don't remove the
  // text fields immediately (which seems to make the keyboard flicker).
  // See: https://github.com/flutter/flutter/issues/64628.
  [self cleanUpViewHierarchy:NO clearText:YES delayRemoval:YES];
}

◆ setTextInputEditingState:

- (void) setTextInputEditingState: (NSDictionary*) state

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                :(NSDictionary*)state {
  [_activeView setTextInputState:state];
}

◆ setUpIndirectScribbleInteraction:

- (void) setUpIndirectScribbleInteraction: (id<FlutterViewResponder>) viewResponder

These are used by the UIIndirectScribbleInteractionDelegate methods to handle focusing on the correct element.

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                        :(id<FlutterViewResponder>)viewResponder {
  if (_viewResponder != viewResponder) {
    if (@available(iOS 14.0, *)) {
      UIView* parentView = viewResponder.view;
      if (parentView != nil) {
        UIIndirectScribbleInteraction* scribbleInteraction = [[UIIndirectScribbleInteraction alloc]
            initWithDelegate:(id<UIIndirectScribbleInteractionDelegate>)self];
        [parentView addInteraction:scribbleInteraction];
      }
    }
  }
  _viewResponder = viewResponder;
}

◆ showEditMenu:

- (BOOL) showEditMenu: (ios(16.0)) API_AVAILABLE

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                    :(NSDictionary*)args API_AVAILABLE(ios(16.0)) {
  if (!self.activeView.isFirstResponder) {
    return NO;
  }
  NSDictionary<NSString*, NSNumber*>* encodedTargetRect = args[@"targetRect"];
  CGRect globalTargetRect = CGRectMake(
      [encodedTargetRect[@"x"] doubleValue], [encodedTargetRect[@"y"] doubleValue],
      [encodedTargetRect[@"width"] doubleValue], [encodedTargetRect[@"height"] doubleValue]);
  CGRect localTargetRect = [self.hostView convertRect:globalTargetRect toView:self.activeView];
  [self.activeView showEditMenuWithTargetRect:localTargetRect];
  return YES;
}

◆ showKeyboardAndRemoveScreenshot

- (void) showKeyboardAndRemoveScreenshot

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                        {
  [UIView setAnimationsEnabled:NO];
  [_cachedFirstResponder becomeFirstResponder];
  // UIKit does not immediately access the areAnimationsEnabled Boolean so a delay is needed before
  // returned
  dispatch_after(dispatch_time(DISPATCH_TIME_NOW, kKeyboardAnimationDelaySeconds * NSEC_PER_SEC),
                 dispatch_get_main_queue(), ^{
                   [UIView setAnimationsEnabled:YES];
                   [self dismissKeyboardScreenshot];
                 });
}

◆ showTextInput

- (void) showTextInput

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                      {
  _activeView.viewResponder = _viewResponder;
  [self addToInputParentViewIfNeeded:_activeView];
  // Adds a delay to prevent the text view from receiving accessibility
  // focus in case it is activated during semantics updates.
  //
  // One common case is when the app navigates to a page with an auto
  // focused text field. The text field will activate the FlutterTextInputView
  // with a semantics update sent to the engine. The voiceover will focus
  // the newly attached active view while performing accessibility update.
  // This results in accessibility focus stuck at the FlutterTextInputView.
  if (!_enableFlutterTextInputViewAccessibilityTimer) {
    _enableFlutterTextInputViewAccessibilityTimer =
        [NSTimer scheduledTimerWithTimeInterval:kUITextInputAccessibilityEnablingDelaySeconds
                                         target:[FlutterTimerProxy proxyWithTarget:self]
                                       selector:@selector(enableActiveViewAccessibility)
                                       userInfo:nil
                                        repeats:NO];
  }
  [_activeView becomeFirstResponder];
}

◆ startLiveTextInput

- (void) startLiveTextInput

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                           {
  if (@available(iOS 15.0, *)) {
    if (_activeView == nil || !_activeView.isFirstResponder) {
      return;
    }
    [_activeView captureTextFromCamera:nil];
  }
}

◆ takeKeyboardScreenshotAndDisplay

- (void) takeKeyboardScreenshotAndDisplay

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                         {
  // View must be loaded at this point
  UIScreen* screen = _viewController.flutterScreenIfViewLoaded;
  UIView* keyboardSnap = [screen snapshotViewAfterScreenUpdates:YES];
  keyboardSnap = [keyboardSnap resizableSnapshotViewFromRect:_keyboardRect
                                          afterScreenUpdates:YES
                                               withCapInsets:UIEdgeInsetsZero];
  _keyboardView = keyboardSnap;
  [_keyboardViewContainer addSubview:_keyboardView];
  if (_keyboardViewContainer.superview == nil) {
    [UIApplication.sharedApplication.delegate.window.rootViewController.view
        addSubview:_keyboardViewContainer];
  }
  _keyboardViewContainer.layer.zPosition = NSIntegerMax;
  _keyboardViewContainer.frame = _keyboardRect;
}

◆ textAffinityString

- (NSString *) textAffinityString

implementation

Return the string representation of the current textAffinity as it should be sent over the FlutterMethodChannel.

Definition at line 339 of file FlutterTextInputPlugin.mm.

                                {
  return (self.textAffinity == kFlutterTextAffinityUpstream) ? kTextAffinityUpstream
                                                             : kTextAffinityDownstream;
}

◆ textInputView

- (UIView< UITextInput > *) textInputView

The UITextInput implementation used to control text entry.

This is used by AccessibilityBridge to forward interactions with iOS' accessibility system.

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                      {
  return _activeView;
}

◆ textInputViews

- (NSArray< UIView * > *) textInputViews

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                    {
  return _inputHider.subviews;
}

◆ triggerAutofillSave:

- (void) triggerAutofillSave: (BOOL) saveEntries

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                           :(BOOL)saveEntries {
  [_activeView resignFirstResponder];
 
  if (saveEntries) {
    // Make all the input fields in the autofill context visible,
    // then remove them to trigger autofill save.
    [self cleanUpViewHierarchy:YES clearText:YES delayRemoval:NO];
    [_autofillContext removeAllObjects];
    [self changeInputViewsAutofillVisibility:YES];
  } else {
    [_autofillContext removeAllObjects];
  }
 
  [self cleanUpViewHierarchy:YES clearText:!saveEntries delayRemoval:NO];
  [self addToInputParentViewIfNeeded:_activeView];
}

◆ unmarkText

- (void) unmarkText

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                   {
  if (_activeModel == nullptr) {
    return;
  }
  _activeModel->CommitComposing();
  _activeModel->EndComposing();
  if (_enableDeltaModel) {
    [self updateEditStateWithDelta:flutter::TextEditingDelta(_activeModel->GetText().c_str())];
  } else {
    [self updateEditState];
  }
}

◆ updateAndShowAutofillViews:focusedField:isPasswordRelated:

- (FlutterTextInputView *) updateAndShowAutofillViews:	(NSArray*)	fields
focusedField:	(NSDictionary*)	focusedField
isPasswordRelated:	(BOOL)	isPassword

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                                                   :(NSArray*)fields
                                       focusedField:(NSDictionary*)focusedField
                                  isPasswordRelated:(BOOL)isPassword {
  FlutterTextInputView* focused = nil;
  NSString* focusedId = AutofillIdFromDictionary(focusedField);
  NSAssert(focusedId, @"autofillId must not be null for the focused field: %@", focusedField);
 
  if (!fields) {
    // DO NOT push the current autofillable input fields to the context even
    // if it's password-related, because it is not in an autofill group.
    focused = [self getOrCreateAutofillableView:focusedField isPasswordAutofill:isPassword];
    [_autofillContext removeObjectForKey:focusedId];
  }
 
  for (NSDictionary* field in fields) {
    NSString* autofillId = AutofillIdFromDictionary(field);
    NSAssert(autofillId, @"autofillId must not be null for field: %@", field);
 
    BOOL hasHints = AutofillTypeOf(field) != kFlutterAutofillTypeNone;
    BOOL isFocused = [focusedId isEqualToString:autofillId];
 
    if (isFocused) {
      focused = [self getOrCreateAutofillableView:field isPasswordAutofill:isPassword];
    }
 
    if (hasHints) {
      // Push the current input field to the context if it has hints.
      _autofillContext[autofillId] = isFocused ? focused
                                               : [self getOrCreateAutofillableView:field
                                                                isPasswordAutofill:isPassword];
    } else {
      // Mark for deletion.
      [_autofillContext removeObjectForKey:autofillId];
    }
  }
 
  NSAssert(focused, @"The current focused input view must not be nil.");
  return focused;
}

◆ updateCaretRect:

- (void) updateCaretRect: (NSDictionary*) dictionary

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                       :(NSDictionary*)dictionary {
  NSAssert(dictionary[@"x"] != nil && dictionary[@"y"] != nil && dictionary[@"width"] != nil &&
               dictionary[@"height"] != nil,
           @"Expected a dictionary representing a CGRect, got %@", dictionary);
  _caretRect = CGRectMake([dictionary[@"x"] doubleValue], [dictionary[@"y"] doubleValue],
                          [dictionary[@"width"] doubleValue], [dictionary[@"height"] doubleValue]);
}

◆ updateConfig:

- (void) updateConfig: (NSDictionary*) dictionary

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                    :(NSDictionary*)dictionary {
  BOOL isSecureTextEntry = [dictionary[kSecureTextEntry] boolValue];
  for (UIView* view in self.textInputViews) {
    if ([view isKindOfClass:[FlutterTextInputView class]]) {
      FlutterTextInputView* inputView = (FlutterTextInputView*)view;
      // The feature of holding and draging spacebar to move cursor is affected by
      // secureTextEntry, so when obscureText is updated, we need to update secureTextEntry
      // and call reloadInputViews.
      // https://github.com/flutter/flutter/issues/122139
      if (inputView.isSecureTextEntry != isSecureTextEntry) {
        inputView.secureTextEntry = isSecureTextEntry;
        [inputView reloadInputViews];
      }
    }
  }
}

◆ updateEditState

- (void) updateEditState

implementation

Informs the Flutter framework of changes to the text input model's state by sending the entire new state.

Definition at line 339 of file FlutterTextInputPlugin.mm.

                        {
  if (_activeModel == nullptr) {
    return;
  }
 
  NSDictionary* state = [self editingState];
  [_channel invokeMethod:kUpdateEditStateResponseMethod arguments:@[ self.clientID, state ]];
  [self updateTextAndSelection];
}

◆ updateEditStateWithDelta:

- (void) updateEditStateWithDelta: (const flutter::TextEditingDelta) delta

implementation

Informs the Flutter framework of changes to the text input model's state by sending only the difference.

Definition at line 339 of file FlutterTextInputPlugin.mm.

                                :(const flutter::TextEditingDelta)delta {
  NSUInteger selectionBase = _activeModel->selection().base();
  NSUInteger selectionExtent = _activeModel->selection().extent();
  int composingBase = _activeModel->composing() ? _activeModel->composing_range().base() : -1;
  int composingExtent = _activeModel->composing() ? _activeModel->composing_range().extent() : -1;
 
  NSString* const textAffinity = [self textAffinityString];
 
  NSDictionary* deltaToFramework = @{
    @"oldText" : @(delta.old_text().c_str()),
    @"deltaText" : @(delta.delta_text().c_str()),
    @"deltaStart" : @(delta.delta_start()),
    @"deltaEnd" : @(delta.delta_end()),
    @"selectionBase" : @(selectionBase),
    @"selectionExtent" : @(selectionExtent),
    @"selectionAffinity" : textAffinity,
    @"selectionIsDirectional" : @(false),
    @"composingBase" : @(composingBase),
    @"composingExtent" : @(composingExtent),
  };
 
  NSDictionary* deltas = @{
    @"deltas" : @[ deltaToFramework ],
  };
 
  [_channel invokeMethod:kUpdateEditStateWithDeltasResponseMethod
               arguments:@[ self.clientID, deltas ]];
  [self updateTextAndSelection];
}

◆ updateMarkedRect:

- (void) updateMarkedRect: (NSDictionary*) dictionary

implementation

Definition at line 2342 of file FlutterTextInputPlugin.mm.

                        :(NSDictionary*)dictionary {
  NSAssert(dictionary[@"x"] != nil && dictionary[@"y"] != nil && dictionary[@"width"] != nil &&
               dictionary[@"height"] != nil,
           @"Expected a dictionary representing a CGRect, got %@", dictionary);
  CGRect rect = CGRectMake([dictionary[@"x"] doubleValue], [dictionary[@"y"] doubleValue],
                           [dictionary[@"width"] doubleValue], [dictionary[@"height"] doubleValue]);
  _activeView.markedRect = rect.size.width < 0 && rect.size.height < 0 ? kInvalidFirstRect : rect;
}

◆ updateTextAndSelection

- (void) updateTextAndSelection

implementation

Updates the stringValue and selectedRange that stored in the NSTextView interface that this plugin inherits from.

If there is a FlutterTextField uses this plugin as its field editor, this method will update the stringValue and selectedRange through the API of the FlutterTextField.

Definition at line 339 of file FlutterTextInputPlugin.mm.

                               {
  NSAssert(_activeModel != nullptr, @"Flutter text model must not be null.");
  NSString* text = @(_activeModel->GetText().data());
  int start = _activeModel->selection().base();
  int extend = _activeModel->selection().extent();
  NSRange selection = NSMakeRange(MIN(start, extend), ABS(start - extend));
  // There may be a native text field client if VoiceOver is on.
  // In this case, this plugin has to update text and selection through
  // the client in order for VoiceOver to announce the text editing
  // properly.
  if (_client) {
    [_client updateString:text withSelection:selection];
  } else {
    self.string = text;
    [self setSelectedRange:selection];
  }
}

◆ validAttributesForMarkedText

- (NSArray< NSString * > *) validAttributesForMarkedText

implementation

Definition at line 339 of file FlutterTextInputPlugin.mm.

                                                    {
  return @[];
}

Member Data Documentation

◆ pad0

- __pad0__

protected

Definition at line 179 of file FlutterTextInputPlugin.h.

Property Documentation

◆ activeView

- (FlutterTextInputView *) activeView

readwritenonatomicassignimplementation

Provided by category FlutterTextInputPlugin().

Definition at line 2333 of file FlutterTextInputPlugin.mm.

◆ autofillContext

- (NSMutableDictionary< NSString *, FlutterTextInputView * > *) autofillContext

readnonatomicassignimplementation

Provided by category FlutterTextInputPlugin().

Definition at line 2332 of file FlutterTextInputPlugin.mm.

◆ cachedFirstResponder

- (UIView *) cachedFirstResponder

readwritenonatomicassignimplementation

Provided by category FlutterTextInputPlugin().

Definition at line 2339 of file FlutterTextInputPlugin.mm.

◆ channel

- (FlutterMethodChannel*) channel

readwritenonatomicassignimplementation

The channel used to communicate with Flutter.

Provided by category FlutterTextInputPlugin().

Definition at line 215 of file FlutterTextInputPlugin.mm.

◆ 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 34 of file FlutterTextInputPlugin.h.

◆ clientID

- (NSNumber*) clientID

readwritenonatomicassignimplementation

ID of the text input client.

Provided by category FlutterTextInputPlugin().

Definition at line 242 of file FlutterTextInputPlugin.mm.

◆ customRunLoopMode

- (NSString*) customRunLoopMode

readwritenonatomicassignimplementation

Allow overriding run loop mode for test.

Provided by category FlutterTextInputPlugin(TestMethods).

Definition at line 319 of file FlutterTextInputPlugin.mm.

◆ enableDeltaModel

- (BOOL) enableDeltaModel

readwritenonatomicassignimplementation

Whether to enable the sending of text input updates from the engine to the framework as TextEditingDeltas rather than as one TextEditingValue. For more information on the delta model, see: https://master-api.flutter.dev/flutter/services/TextInputConfiguration/enableDeltaModel.html

Provided by category FlutterTextInputPlugin().

Definition at line 269 of file FlutterTextInputPlugin.mm.

◆ eventProducedOutput

- (BOOL) eventProducedOutput

readwritenonatomicassignimplementation

Set to true if the last event fed to the input context produced a text editing command or text output. It is reset to false at the beginning of every key event, and is only used while processing this event.

Provided by category FlutterTextInputPlugin().

Definition at line 261 of file FlutterTextInputPlugin.mm.

◆ flutterViewController

- (FlutterViewController*) flutterViewController

readwritenonatomicweakimplementation

The FlutterViewController to manage input for.

Provided by category FlutterTextInputPlugin().

Definition at line 220 of file FlutterTextInputPlugin.mm.

◆ indirectScribbleDelegate

- (id<FlutterIndirectScribbleDelegate>) indirectScribbleDelegate

readwritenonatomicweak

Definition at line 37 of file FlutterTextInputPlugin.h.

◆ inputAction

- (NSString*) inputAction

readwritenonatomicassignimplementation

An action requested by the user on the input client. See available options: https://api.flutter.dev/flutter/services/TextInputAction-class.html

Provided by category FlutterTextInputPlugin().

Definition at line 254 of file FlutterTextInputPlugin.mm.

◆ inputHider [1/2]

- (FlutterTextInputViewAccessibilityHider*) inputHider

readwritenonatomicretainimplementation

Provided by category FlutterTextInputPlugin().

Definition at line 2334 of file FlutterTextInputPlugin.mm.

◆ inputHider [2/2]

- (UIView*) inputHider

readnonatomicassignimplementation

Provided by category FlutterTextInputPlugin().

Definition at line 64 of file FlutterTextInputPluginTest.mm.

◆ inputType

- (NSString*) inputType

readwritenonatomicassignimplementation

Keyboard type of the client. See available options: https://api.flutter.dev/flutter/services/TextInputType-class.html

Provided by category FlutterTextInputPlugin().

Definition at line 248 of file FlutterTextInputPlugin.mm.

◆ keyboardRect

- (CGRect) keyboardRect

readwritenonatomicassignimplementation

Provided by category FlutterTextInputPlugin().

Definition at line 2340 of file FlutterTextInputPlugin.mm.

◆ keyboardView

- (UIView *) keyboardView

readwritenonatomicassignimplementation

Provided by category FlutterTextInputPlugin().

Definition at line 2338 of file FlutterTextInputPlugin.mm.

◆ keyboardViewContainer

- (UIView *) keyboardViewContainer

readwritenonatomicassignimplementation

Provided by category FlutterTextInputPlugin().

Definition at line 2337 of file FlutterTextInputPlugin.mm.

◆ pendingSelectors

- (NSMutableArray*) pendingSelectors

readwritenonatomicassignimplementation

Used to gather multiple selectors performed in one run loop turn. These will be all sent in one platform channel call so that the framework can process them in single microtask.

Provided by category FlutterTextInputPlugin().

Definition at line 276 of file FlutterTextInputPlugin.mm.

◆ pointerYVelocity

- (CGFloat) pointerYVelocity

readwritenonatomicassignimplementation

Provided by category FlutterTextInputPlugin().

Definition at line 2342 of file FlutterTextInputPlugin.mm.

◆ previouslyPressedFlags

- (uint64_t) previouslyPressedFlags

readwritenonatomicassignimplementation

The current state of the keyboard and pressed keys.

Provided by category FlutterTextInputPlugin().

Definition at line 232 of file FlutterTextInputPlugin.mm.

◆ previousPointerYPosition

- (CGFloat) previousPointerYPosition

readwritenonatomicassignimplementation

Provided by category FlutterTextInputPlugin().

Definition at line 2341 of file FlutterTextInputPlugin.mm.

◆ scribbleElements

- (NSMutableDictionary<UIScribbleElementIdentifier, NSValue*>*) scribbleElements

readwritenonatomicstrong

Definition at line 39 of file FlutterTextInputPlugin.h.

◆ shown

- (BOOL) shown

readwritenonatomicassignimplementation

Whether the text input is shown in the view.

Defaults to TRUE on startup.

Provided by category FlutterTextInputPlugin().

Definition at line 227 of file FlutterTextInputPlugin.mm.

◆ textAffinity

- (FlutterTextAffinity) textAffinity

readwriteatomicimplementation

The affinity for the current cursor position.

Provided by category FlutterTextInputPlugin().

Definition at line 237 of file FlutterTextInputPlugin.mm.

◆ textInputContext

- (NSTextInputContext*) textInputContext

readwritenonatomicassignimplementation

A text input context, representing a connection to the Cocoa text input system.

Provided by category FlutterTextInputPlugin(TestMethods).

Definition at line 210 of file FlutterTextInputPlugin.mm.

◆ textInputDelegate

- (id<FlutterTextInputDelegate>) textInputDelegate

readnonatomicweakimplementation

Provided by category FlutterTextInputPlugin().

Definition at line 779 of file FlutterTextInputPlugin.mm.

◆ viewController

- (UIIndirectScribbleInteractionDelegate UIViewController*) viewController

readwritenonatomicweak

Definition at line 36 of file FlutterTextInputPlugin.h.

◆ viewResponder

- (id<FlutterViewResponder>) viewResponder

readnonatomicweakimplementation

Provided by category FlutterTextInputPlugin().

Definition at line 2335 of file FlutterTextInputPlugin.mm.

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

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

Instance Methods

Class Methods

Protected Attributes

Properties

Detailed Description

Method Documentation

◆ addToInputParentViewIfNeeded:

◆ API_AVAILABLE

◆ attributedSubstringForProposedRange:actualRange:

◆ changeInputViewsAutofillVisibility:

◆ characterIndexForPoint:

◆ cleanUpViewHierarchy:clearText:delayRemoval:

◆ clearTextInputClient

◆ createInputViewWith:

◆ dealloc

◆ dismissKeyboardScreenshot

◆ doCommandBySelector:

◆ editingState

◆ enableActiveViewAccessibility

◆ firstRectForCharacterRange:actualRange:

◆ flagsChanged:

◆ getOrCreateAutofillableView:isPasswordAutofill:

◆ handleKeyboardWillShow:

◆ handleKeyEvent:

◆ handleMethodCall:result:

◆ handlePointerMove:

◆ handlePointerUp:

◆ handlePress:

◆ hasMarkedText

◆ hideEditMenu

◆ hideKeyboardWithoutAnimationAndAvoidCursorDismissUpdate

◆ hideTextInput

◆ hostView

◆ indirectScribbleInteraction:didFinishWritingInElement:

◆ indirectScribbleInteraction:focusElementIfNeeded:referencePoint:completion:

◆ indirectScribbleInteraction:frameForElement:

◆ indirectScribbleInteraction:isElementFocused:

◆ indirectScribbleInteraction:requestElementsInRect:completion:

◆ indirectScribbleInteraction:shouldDelayFocusForElement:

◆ indirectScribbleInteraction:willBeginWritingInElement:

◆ initWithDelegate:

◆ initWithViewController:

◆ inputContext

◆ insertNewline:

◆ insertTab:

◆ insertText:replacementRange:

◆ isFirstResponder

◆ keyDown:

◆ keyUp:

◆ markedRange

◆ mouseDown:

◆ mouseDragged:

◆ mouseMoved:

◆ mouseUp:

◆ NS_UNAVAILABLE [1/2]

◆ NS_UNAVAILABLE [2/2]

◆ otherMouseDown:

◆ otherMouseDragged:

◆ otherMouseUp:

◆ performKeyEquivalent:

◆ removeEnableFlutterTextInputViewAccessibilityTimer

◆ resetAllClientIds

◆ resetViewResponder

◆ resignAndRemoveFromSuperview

◆ rightMouseDown:

◆ rightMouseDragged:

◆ rightMouseUp:

◆ screenRectFromFrameworkTransform:

◆ scrollWheel:

◆ setEditableSizeAndTransform:

◆ setEditableTransform:

◆ setEditingState:

◆ setKeyboardContainerHeight:

◆ setMarkedText:selectedRange:replacementRange:

◆ setPlatformViewTextInputClient

◆ setSelectionRects:

◆ setTextInputClient:withConfiguration:

◆ setTextInputEditingState:

◆ setUpIndirectScribbleInteraction:

◆ showEditMenu:

◆ pad0