Flutter Engine Uber Docs
Docs for the entire Flutter Engine repo.
 
Loading...
Searching...
No Matches
Instance Methods | Protected Attributes | Properties | List of all members
FlutterTextInputPlugin() Category Reference

Instance Methods

(void) - enableActiveViewAccessibility
 
(void) - cleanUpViewHierarchy:clearText:delayRemoval:
 
(NSArray< UIView * > *) - textInputViews
 
(UIView *) - hostView
 
(void) - addToInputParentViewIfNeeded:
 
(void) - startLiveTextInput
 
(void) - showKeyboardAndRemoveScreenshot
 
(void) - handleMethodCall:result:
 
(void) - setEditingState:
 
(void) - updateEditState
 
(void) - updateEditStateWithDelta:
 
(void) - updateTextAndSelection
 
(NSString *) - textAffinityString
 

Protected Attributes

NSTextInputContext * _textInputContext
 
FlutterMethodChannel * _channel
 
__weak FlutterViewController * _currentViewController
 
__weak FlutterViewController * _originalViewController
 
__weak id< FlutterTextInputPluginDelegate > _delegate
 
BOOL _shown
 
uint64_t _previouslyPressedFlags
 
FlutterTextAffinity _textAffinity
 
NSNumber * _clientID
 
NSString * _inputType
 
NSString * _inputAction
 
BOOL _eventProducedOutput
 
BOOL _enableDeltaModel
 
NSMutableArray * _pendingSelectors
 
std::unique_ptr< flutter::TextInputModel > _activeModel
 
CATransform3D _editableTransform
 
CGRect _caretRect
 

Properties

id< FlutterTextInputDelegate > textInputDelegate
 
UIView * hostView
 
NSMutableDictionary< NSString *, FlutterTextInputView * > * autofillContext
 
BOOL pendingAutofillRemoval
 
BOOL pendingInputViewRemoval
 
FlutterTextInputView * activeView
 
FlutterTextInputViewAccessibilityHider * inputHider
 
id< FlutterViewResponder > viewResponder
 
UIView * keyboardViewContainer
 
UIView * keyboardView
 
UIView * cachedFirstResponder
 
CGRect keyboardRect
 
CGFloat previousPointerYPosition
 
CGFloat pointerYVelocity
 
UIView * inputHider
 
NSString * customRunLoopMode
 
NSTextInputContext * textInputContext
 

Detailed Description

Private properties of FlutterTextInputPlugin.

Definition at line 788 of file FlutterTextInputPlugin.mm.

Method Documentation

◆ addToInputParentViewIfNeeded:

- (void) addToInputParentViewIfNeeded: (FlutterTextInputView *)  inputView

References action, args, callback, message, settings_, surface, texture, texture_id, type, and view_id.

◆ cleanUpViewHierarchy:clearText:delayRemoval:

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

◆ enableActiveViewAccessibility

- (void) enableActiveViewAccessibility

◆ handleMethodCall:result:

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

Handles a Flutter system message on the text input channel.

◆ hostView

- (UIView *) hostView

◆ setEditingState:

- (void) setEditingState: (NSDictionary *)  state

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

◆ showKeyboardAndRemoveScreenshot

- (void) showKeyboardAndRemoveScreenshot

◆ startLiveTextInput

- (void) startLiveTextInput

◆ textAffinityString

- (NSString *) textAffinityString

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

◆ textInputViews

- (NSArray< UIView * > *) textInputViews

◆ updateEditState

- (void) updateEditState

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

◆ updateEditStateWithDelta:

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

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

◆ updateTextAndSelection

- (void) updateTextAndSelection

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.

Member Data Documentation

◆ _activeModel

- (unique_ptr<)flutter:
protected

The currently active text input model.

Definition at line 294 of file FlutterTextInputPlugin.mm.

◆ _caretRect

- (CGRect) _caretRect
protected

Current position of caret in local (editable) coordinates.

Definition at line 304 of file FlutterTextInputPlugin.mm.

◆ _channel

- (FlutterMethodChannel*) _channel
protected

The channel used to communicate with Flutter.

Definition at line 216 of file FlutterTextInputPlugin.mm.

◆ _clientID

- (NSNumber*) _clientID
protected

ID of the text input client.

Definition at line 255 of file FlutterTextInputPlugin.mm.

◆ _currentViewController

- (__weak FlutterViewController*) _currentViewController
protected

The FlutterViewController to manage input for.

Definition at line 221 of file FlutterTextInputPlugin.mm.

◆ _delegate

- (__weak id<FlutterTextInputPluginDelegate>) _delegate
protected

Used to obtain view controller on client creation

Definition at line 233 of file FlutterTextInputPlugin.mm.

◆ _editableTransform

- (CATransform3D) _editableTransform
protected

Transform for current the editable. Used to determine position of accent selection menu.

Definition at line 299 of file FlutterTextInputPlugin.mm.

◆ _enableDeltaModel

- (BOOL) _enableDeltaModel
protected

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

Definition at line 282 of file FlutterTextInputPlugin.mm.

◆ _eventProducedOutput

- (BOOL) _eventProducedOutput
protected

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.

Definition at line 274 of file FlutterTextInputPlugin.mm.

◆ _inputAction

- (NSString*) _inputAction
protected

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

Definition at line 267 of file FlutterTextInputPlugin.mm.

◆ _inputType

- (NSString*) _inputType
protected

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

Definition at line 261 of file FlutterTextInputPlugin.mm.

◆ _originalViewController

- (__weak FlutterViewController*) _originalViewController
protected

The originally requested view controller. This may be attached to a window that is a descendant of _currentViewController window in case the window can not become a key window (i.e. popup window).

Definition at line 228 of file FlutterTextInputPlugin.mm.

◆ _pendingSelectors

- (NSMutableArray*) _pendingSelectors
protected

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.

Definition at line 289 of file FlutterTextInputPlugin.mm.

◆ _previouslyPressedFlags

- (uint64_t) _previouslyPressedFlags
protected

The current state of the keyboard and pressed keys.

Definition at line 245 of file FlutterTextInputPlugin.mm.

◆ _shown

- (BOOL) _shown
protected

Whether the text input is shown in the view.

Defaults to TRUE on startup.

Definition at line 240 of file FlutterTextInputPlugin.mm.

◆ _textAffinity

- (FlutterTextAffinity) _textAffinity
protected

The affinity for the current cursor position.

Definition at line 250 of file FlutterTextInputPlugin.mm.

◆ _textInputContext

- (NSTextInputContext*) _textInputContext
protected

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

Definition at line 211 of file FlutterTextInputPlugin.mm.

Property Documentation

◆ activeView

- (FlutterTextInputView *) activeView
readwritenonatomicassign

Definition at line 2531 of file FlutterTextInputPlugin.mm.

◆ autofillContext

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

Definition at line 2521 of file FlutterTextInputPlugin.mm.

◆ cachedFirstResponder

- (UIView *) cachedFirstResponder
readwritenonatomicassign

Definition at line 2537 of file FlutterTextInputPlugin.mm.

◆ customRunLoopMode

- (NSString*) customRunLoopMode
readwritenonatomicassign

Allow overriding run loop mode for test.

Definition at line 348 of file FlutterTextInputPlugin.mm.

◆ hostView

- (UIView*) hostView
readnonatomicassign

Definition at line 790 of file FlutterTextInputPlugin.mm.

◆ inputHider [1/2]

- (FlutterTextInputViewAccessibilityHider*) inputHider
readwritenonatomicretain

Definition at line 2532 of file FlutterTextInputPlugin.mm.

◆ inputHider [2/2]

- (UIView*) inputHider
readnonatomicassign

Definition at line 67 of file FlutterTextInputPluginTest.mm.

◆ keyboardRect

- (CGRect) keyboardRect
readwritenonatomicassign

Definition at line 2538 of file FlutterTextInputPlugin.mm.

◆ keyboardView

- (UIView *) keyboardView
readwritenonatomicassign

Definition at line 2536 of file FlutterTextInputPlugin.mm.

◆ keyboardViewContainer

- (UIView *) keyboardViewContainer
readwritenonatomicassign

Definition at line 2535 of file FlutterTextInputPlugin.mm.

◆ pendingAutofillRemoval

- (BOOL) pendingAutofillRemoval
readnonatomicassign

Definition at line 2525 of file FlutterTextInputPlugin.mm.

◆ pendingInputViewRemoval

- (BOOL) pendingInputViewRemoval
readnonatomicassign

Definition at line 2530 of file FlutterTextInputPlugin.mm.

◆ pointerYVelocity

- (CGFloat) pointerYVelocity
readwritenonatomicassign

Definition at line 2540 of file FlutterTextInputPlugin.mm.

◆ previousPointerYPosition

- (CGFloat) previousPointerYPosition
readwritenonatomicassign

Definition at line 2539 of file FlutterTextInputPlugin.mm.

◆ textInputContext

- (NSTextInputContext*) textInputContext
readwritenonatomicassign

Definition at line 349 of file FlutterTextInputPlugin.mm.

◆ textInputDelegate

- (id<FlutterTextInputDelegate>) textInputDelegate
readnonatomicweak

Definition at line 789 of file FlutterTextInputPlugin.mm.

◆ viewResponder

- (id<FlutterViewResponder>) viewResponder
readnonatomicweak

Definition at line 2533 of file FlutterTextInputPlugin.mm.

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