FlutterTextInputPlugin Class Reference

#import <FlutterTextInputPlugin.h>

Instance Methods
(instancetype)	- NS_UNAVAILABLE
(instancetype)	- initWithDelegate:
(void)	- handleMethodCall:result:
(void)	- reset
(UIView< UITextInput > *)	- textInputView
(void)	- setUpIndirectScribbleInteraction:
(void)	- resetViewResponder
(BOOL)	- showEditMenu:
(ios(16.0)	- API_AVAILABLE

Class Methods
(instancetype)	+ NS_UNAVAILABLE

Protected Attributes
	__pad0__: NSObject <FlutterKeySecondaryResponder

Properties
UIIndirectScribbleInteractionDelegate UIViewController *	viewController
id< FlutterIndirectScribbleDelegate >	indirectScribbleDelegate
NSMutableDictionary< UIScribbleElementIdentifier, NSValue * > *	scribbleElements

Detailed Description

Definition at line 33 of file FlutterTextInputPlugin.h.

Method Documentation

API_AVAILABLE

- (ios(16.0) API_AVAILABLE

handleMethodCall:result:

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

Definition at line 2509 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);
  }
}

initWithDelegate:

- (instancetype) initWithDelegate:

(id<FlutterTextInputDelegate>)

NS_DESIGNATED_INITIALIZER

Initial value:

{
  NSTimer* _enableFlutterTextInputViewAccessibilityTimer

Definition at line 2509 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;
}

NS_UNAVAILABLE [1/2]

+ (instancetype) NS_UNAVAILABLE

NS_UNAVAILABLE [2/2]

- (instancetype) NS_UNAVAILABLE

reset

- (void) reset

Reset the text input plugin to prepare for a hot restart.

This hides the software keyboard and text editing context menu.

Definition at line 2509 of file FlutterTextInputPlugin.mm.

              {
  [self hideTextInput];
}

resetViewResponder

- (void) resetViewResponder

Definition at line 2509 of file FlutterTextInputPlugin.mm.

                           {
  _viewResponder = nil;
}

setUpIndirectScribbleInteraction:

- (void) setUpIndirectScribbleInteraction:

(id<FlutterViewResponder>)

viewResponder

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

Definition at line 2509 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 2509 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 items:args[@"items"]];
  return YES;
}

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

                                      {
  return _activeView;
}

Member Data Documentation

__pad0__

- __pad0__

protected

Definition at line 186 of file FlutterTextInputPlugin.h.

Property Documentation

indirectScribbleDelegate

- (id<FlutterIndirectScribbleDelegate>) indirectScribbleDelegate

readwritenonatomicweak

Definition at line 37 of file FlutterTextInputPlugin.h.

scribbleElements

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

readwritenonatomicstrong

Definition at line 39 of file FlutterTextInputPlugin.h.

viewController

- (UIIndirectScribbleInteractionDelegate UIViewController*) viewController

readwritenonatomicweak

Definition at line 36 of file FlutterTextInputPlugin.h.

---

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

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