#import <TextInputSemanticsObject.h>

Inheritance diagram for TextInputSemanticsObject:

Instance Methods
(instancetype)	- initWithBridge:uid: `[implementation]`

(void)	- setSemanticsNode: `[implementation]`

(UIView< UITextInput > *)	- textInputSurrogate `[implementation]`

(UIView *)	- textInputView `[implementation]`

(void)	- accessibilityElementDidBecomeFocused `[implementation]`

(void)	- accessibilityElementDidLoseFocus `[implementation]`

(BOOL)	- accessibilityElementIsFocused `[implementation]`

(BOOL)	- accessibilityActivate `[implementation]`

(NSString *)	- accessibilityLabel `[implementation]`

(NSString *)	- accessibilityHint `[implementation]`

(NSString *)	- accessibilityValue `[implementation]`

(UIAccessibilityTraits)	- accessibilityTraits `[implementation]`

(NSString *)	- textInRange: `[implementation]`

(void)	- replaceRange:withText: `[implementation]`

(BOOL)	- shouldChangeTextInRange:replacementText: `[implementation]`

(UITextRange *)	- selectedTextRange `[implementation]`

(void)	- setSelectedTextRange: `[implementation]`

(UITextRange *)	- markedTextRange `[implementation]`

(NSDictionary *)	- markedTextStyle `[implementation]`

(void)	- setMarkedTextStyle: `[implementation]`

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

(void)	- unmarkText `[implementation]`

(UITextStorageDirection)	- selectionAffinity `[implementation]`

(UITextPosition *)	- beginningOfDocument `[implementation]`

(UITextPosition *)	- endOfDocument `[implementation]`

(id< UITextInputDelegate >)	- inputDelegate `[implementation]`

(void)	- setInputDelegate: `[implementation]`

(id< UITextInputTokenizer >)	- tokenizer `[implementation]`

(UITextRange *)	- textRangeFromPosition:toPosition: `[implementation]`

(UITextPosition *)	- positionFromPosition:offset: `[implementation]`

(UITextPosition *)	- positionFromPosition:inDirection:offset: `[implementation]`

(NSComparisonResult)	- comparePosition:toPosition: `[implementation]`

(NSInteger)	- offsetFromPosition:toPosition: `[implementation]`

(UITextPosition *)	- positionWithinRange:farthestInDirection: `[implementation]`

(UITextRange *)	- characterRangeByExtendingPosition:inDirection: `[implementation]`

(UITextWritingDirection)	- baseWritingDirectionForPosition:inDirection: `[implementation]`

(void)	- setBaseWritingDirection:forRange: `[implementation]`

(CGRect)	- firstRectForRange: `[implementation]`

(CGRect)	- caretRectForPosition: `[implementation]`

(UITextPosition *)	- closestPositionToPoint: `[implementation]`

(UITextPosition *)	- closestPositionToPoint:withinRange: `[implementation]`

(NSArray *)	- selectionRectsForRange: `[implementation]`

(UITextRange *)	- characterRangeAtPoint: `[implementation]`

(void)	- insertText: `[implementation]`

(void)	- deleteBackward `[implementation]`

(BOOL)	- hasText `[implementation]`

Instance Methods inherited from SemanticsObject
(BOOL)	- isAccessibilityBridgeAlive

(void)	- setSemanticsNode:

(void)	- replaceChildAtIndex:withChild:

(BOOL)	- nodeWillCauseLayoutChange:

(BOOL)	- nodeWillCauseScroll:

(BOOL)	- nodeShouldTriggerAnnouncement:

(void)	- collectRoutes:

(NSString *)	- routeName

(BOOL)	- onCustomAccessibilityAction:

(void)	- accessibilityBridgeDidFinishUpdate

((unavailable("Use initWithBridge instead")	- __attribute__

(instancetype)	- initWithBridge:uid:

(void)	- dealloc `[implementation]`

(void)	- setChildren: `[implementation]`

(void)	- setChildrenInHitTestOrder: `[implementation]`

(NSAttributedString *)	- createAttributedStringFromString:withAttributes: `[implementation]`

(void)	- showOnScreen `[implementation]`

(BOOL)	- isAccessibilityElement `[implementation]`

(bool)	- isFocusable `[implementation]`

(NSString *)	- accessibilityIdentifier `[implementation]`

(NSString *)	- accessibilityLabel `[implementation]`

(bool)	- containsPoint: `[implementation]`

(id)	- search: `[implementation]`

(id)	- _accessibilityHitTest:withEvent: `[implementation]`

(BOOL)	- accessibilityScrollToVisible `[implementation]`

(BOOL)	- accessibilityScrollToVisibleWithChild: `[implementation]`

(NSAttributedString *)	- accessibilityAttributedLabel `[implementation]`

(NSString *)	- accessibilityHint `[implementation]`

(NSAttributedString *)	- accessibilityAttributedHint `[implementation]`

(NSString *)	- accessibilityValue `[implementation]`

(NSAttributedString *)	- accessibilityAttributedValue `[implementation]`

(CGRect)	- accessibilityFrame `[implementation]`

(CGRect)	- globalRect `[implementation]`

(void)	- setAccessibilityContainer: `[implementation]`

(id)	- accessibilityContainer `[implementation]`

(BOOL)	- accessibilityActivate `[implementation]`

(void)	- accessibilityIncrement `[implementation]`

(void)	- accessibilityDecrement `[implementation]`

(BOOL)	- accessibilityScroll: `[implementation]`

(BOOL)	- accessibilityPerformEscape `[implementation]`

(void)	- accessibilityElementDidBecomeFocused `[implementation]`

(void)	- accessibilityElementDidLoseFocus `[implementation]`

Additional Inherited Members
Properties inherited from SemanticsObject
int32_t	uid

SemanticsObject *	parent

fml::WeakPtr< flutter::AccessibilityBridgeIos >	bridge

flutter::SemanticsNode	node

BOOL	hasChildren

NSArray< SemanticsObject * > *	children

NSArray< SemanticsObject * > *	childrenInHitTestOrder

id	nativeAccessibility

SemanticsObjectContainer *	container `[implementation]`

Detailed Description

An implementation of SemanticsObject specialized for expressing text fields.

Delegates to FlutterTextInputView when the object corresponds to a text field that currently owns input focus. Delegates to FlutterInactiveTextInput otherwise.

Definition at line 20 of file TextInputSemanticsObject.h.

Method Documentation

◆ accessibilityActivate

- (BOOL) accessibilityActivate

implementation

Reimplemented from SemanticsObject.

Definition at line 20 of file TextInputSemanticsObject.mm.

                              {
  if (![self isAccessibilityBridgeAlive]) {
    return false;
  }
  return [[self textInputSurrogate] accessibilityActivate];
}

◆ accessibilityElementDidBecomeFocused

- (void) accessibilityElementDidBecomeFocused

implementation

Reimplemented from SemanticsObject.

Definition at line 20 of file TextInputSemanticsObject.mm.

                                             {
  if (![self isAccessibilityBridgeAlive]) {
    return;
  }
  [[self textInputSurrogate] accessibilityElementDidBecomeFocused];
  [super accessibilityElementDidBecomeFocused];
}

◆ accessibilityElementDidLoseFocus

- (void) accessibilityElementDidLoseFocus

implementation

Reimplemented from SemanticsObject.

Definition at line 20 of file TextInputSemanticsObject.mm.

                                         {
  if (![self isAccessibilityBridgeAlive]) {
    return;
  }
  [[self textInputSurrogate] accessibilityElementDidLoseFocus];
  [super accessibilityElementDidLoseFocus];
}

◆ accessibilityElementIsFocused

- (BOOL) accessibilityElementIsFocused

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                      {
  if (![self isAccessibilityBridgeAlive]) {
    return false;
  }
  return [self node].HasFlag(flutter::SemanticsFlags::kIsFocused);
}

◆ accessibilityHint

- (NSString *) accessibilityHint

implementation

Reimplemented from SemanticsObject.

Definition at line 20 of file TextInputSemanticsObject.mm.

                               {
  if (![self isAccessibilityBridgeAlive]) {
    return nil;
  }
  NSString* hint = [super accessibilityHint];
  if (hint != nil) {
    return hint;
  }
  return [self textInputSurrogate].accessibilityHint;
}

◆ accessibilityLabel

- (NSString *) accessibilityLabel

implementation

Reimplemented from SemanticsObject.

Definition at line 20 of file TextInputSemanticsObject.mm.

                                {
  if (![self isAccessibilityBridgeAlive]) {
    return nil;
  }
 
  NSString* label = [super accessibilityLabel];
  if (label != nil) {
    return label;
  }
  return [self textInputSurrogate].accessibilityLabel;
}

◆ accessibilityTraits

- (UIAccessibilityTraits) accessibilityTraits

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                             {
  if (![self isAccessibilityBridgeAlive]) {
    return 0;
  }
  UIAccessibilityTraits results =
      [super accessibilityTraits] | [self textInputSurrogate].accessibilityTraits;
  // We remove an undocumented flag to get rid of a bug where single-tapping
  // a text input field incorrectly says "empty line".
  // See also: https://github.com/flutter/flutter/issues/52487
  return results & (~kUIAccessibilityTraitUndocumentedEmptyLine);
}

◆ accessibilityValue

- (NSString *) accessibilityValue

implementation

Reimplemented from SemanticsObject.

Definition at line 20 of file TextInputSemanticsObject.mm.

                                {
  if (![self isAccessibilityBridgeAlive]) {
    return nil;
  }
  NSString* value = [super accessibilityValue];
  if (value != nil) {
    return value;
  }
  return [self textInputSurrogate].accessibilityValue;
}

◆ baseWritingDirectionForPosition:inDirection:

- (UITextWritingDirection) baseWritingDirectionForPosition:	(UITextPosition*)	position
inDirection:	(UITextStorageDirection)	direction

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                                         :(UITextPosition*)position
                                              inDirection:(UITextStorageDirection)direction {
  return [[self textInputSurrogate] baseWritingDirectionForPosition:position inDirection:direction];
}

◆ beginningOfDocument

- (UITextPosition *) beginningOfDocument

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                       {
  return [[self textInputSurrogate] beginningOfDocument];
}

◆ caretRectForPosition:

- (CGRect) caretRectForPosition: (UITextPosition*) position

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                              :(UITextPosition*)position {
  return [[self textInputSurrogate] caretRectForPosition:position];
}

◆ characterRangeAtPoint:

- (UITextRange *) characterRangeAtPoint: (CGPoint) point

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                     :(CGPoint)point {
  return [[self textInputSurrogate] characterRangeAtPoint:point];
}

◆ characterRangeByExtendingPosition:inDirection:

- (UITextRange *) characterRangeByExtendingPosition:	(UITextPosition*)	position
inDirection:	(UITextLayoutDirection)	direction

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                                 :(UITextPosition*)position
                                      inDirection:(UITextLayoutDirection)direction {
  return [[self textInputSurrogate] characterRangeByExtendingPosition:position
                                                          inDirection:direction];
}

◆ closestPositionToPoint:

- (UITextPosition *) closestPositionToPoint: (CGPoint) point

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                         :(CGPoint)point {
  return [[self textInputSurrogate] closestPositionToPoint:point];
}

◆ closestPositionToPoint:withinRange:

- (UITextPosition *) closestPositionToPoint:	(CGPoint)	point
withinRange:	(UITextRange*)	range

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                         :(CGPoint)point withinRange:(UITextRange*)range {
  return [[self textInputSurrogate] closestPositionToPoint:point withinRange:range];
}

◆ comparePosition:toPosition:

- (NSComparisonResult) comparePosition:	(UITextPosition*)	position
toPosition:	(UITextPosition*)	other

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                     :(UITextPosition*)position toPosition:(UITextPosition*)other {
  return [[self textInputSurrogate] comparePosition:position toPosition:other];
}

◆ deleteBackward

- (void) deleteBackward

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                       {
  [[self textInputSurrogate] deleteBackward];
}

◆ endOfDocument

- (UITextPosition *) endOfDocument

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                 {
  return [[self textInputSurrogate] endOfDocument];
}

◆ firstRectForRange:

- (CGRect) firstRectForRange: (UITextRange*) range

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                           :(UITextRange*)range {
  return [[self textInputSurrogate] firstRectForRange:range];
}

◆ hasText

- (BOOL) hasText

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                {
  return [[self textInputSurrogate] hasText];
}

◆ initWithBridge:uid:

- (instancetype) initWithBridge:	(fml::WeakPtr<flutter::AccessibilityBridgeIos>)	bridge
uid:	(int32_t)	uid

implementation

Reimplemented from SemanticsObject.

Definition at line 20 of file TextInputSemanticsObject.mm.

                              :(fml::WeakPtr<flutter::AccessibilityBridgeIos>)bridge
                           uid:(int32_t)uid {
  self = [super initWithBridge:bridge uid:uid];
 
  if (self) {
    _inactive_text_input = [[FlutterInactiveTextInput alloc] init];
  }
 
  return self;
}

◆ inputDelegate

- (id< UITextInputDelegate >) inputDelegate

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                         {
  return [[self textInputSurrogate] inputDelegate];
}

◆ insertText:

- (void) insertText: (NSString*) text

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                  :(NSString*)text {
  [[self textInputSurrogate] insertText:text];
}

◆ markedTextRange

- (UITextRange *) markedTextRange

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                {
  return [[self textInputSurrogate] markedTextRange];
}

◆ markedTextStyle

- (NSDictionary *) markedTextStyle

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                 {
  return [[self textInputSurrogate] markedTextStyle];
}

◆ offsetFromPosition:toPosition:

- (NSInteger) offsetFromPosition:	(UITextPosition*)	from
toPosition:	(UITextPosition*)	toPosition

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                               :(UITextPosition*)from toPosition:(UITextPosition*)toPosition {
  return [[self textInputSurrogate] offsetFromPosition:from toPosition:toPosition];
}

◆ positionFromPosition:inDirection:offset:

- (UITextPosition *) positionFromPosition:	(UITextPosition*)	position
inDirection:	(UITextLayoutDirection)	direction
offset:	(NSInteger)	offset

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                       :(UITextPosition*)position
                            inDirection:(UITextLayoutDirection)direction
                                 offset:(NSInteger)offset {
  return [[self textInputSurrogate] positionFromPosition:position
                                             inDirection:direction
                                                  offset:offset];
}

◆ positionFromPosition:offset:

- (UITextPosition *) positionFromPosition:	(UITextPosition*)	position
offset:	(NSInteger)	offset

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                       :(UITextPosition*)position offset:(NSInteger)offset {
  return [[self textInputSurrogate] positionFromPosition:position offset:offset];
}

◆ positionWithinRange:farthestInDirection:

- (UITextPosition *) positionWithinRange:	(UITextRange*)	range
farthestInDirection:	(UITextLayoutDirection)	direction

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                      :(UITextRange*)range
                   farthestInDirection:(UITextLayoutDirection)direction {
  return [[self textInputSurrogate] positionWithinRange:range farthestInDirection:direction];
}

◆ replaceRange:withText:

- (void) replaceRange:	(UITextRange*)	range
withText:	(NSString*)	text

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                    :(UITextRange*)range withText:(NSString*)text {
  return [[self textInputSurrogate] replaceRange:range withText:text];
}

◆ selectedTextRange

- (UITextRange *) selectedTextRange

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                  {
  return [[self textInputSurrogate] selectedTextRange];
}

◆ selectionAffinity

- (UITextStorageDirection) selectionAffinity

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                            {
  return [[self textInputSurrogate] selectionAffinity];
}

◆ selectionRectsForRange:

- (NSArray *) selectionRectsForRange: (UITextRange*) range

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                  :(UITextRange*)range {
  return [[self textInputSurrogate] selectionRectsForRange:range];
}

◆ setBaseWritingDirection:forRange:

- (void) setBaseWritingDirection:	(UITextWritingDirection)	writingDirection
forRange:	(UITextRange*)	range

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                               :(UITextWritingDirection)writingDirection
                       forRange:(UITextRange*)range {
  [[self textInputSurrogate] setBaseWritingDirection:writingDirection forRange:range];
}

◆ setInputDelegate:

- (void) setInputDelegate: (id<UITextInputDelegate>) delegate

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                        :(id<UITextInputDelegate>)delegate {
  [[self textInputSurrogate] setInputDelegate:delegate];
}

◆ setMarkedText:selectedRange:

- (void) setMarkedText:	(NSString*)	markedText
selectedRange:	(NSRange)	selectedRange

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                     :(NSString*)markedText selectedRange:(NSRange)selectedRange {
  [[self textInputSurrogate] setMarkedText:markedText selectedRange:selectedRange];
}

◆ setMarkedTextStyle:

- (void) setMarkedTextStyle: (NSDictionary*) style

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                          :(NSDictionary*)style {
  [[self textInputSurrogate] setMarkedTextStyle:style];
}

◆ setSelectedTextRange:

- (void) setSelectedTextRange: (UITextRange*) range

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                            :(UITextRange*)range {
  [[self textInputSurrogate] setSelectedTextRange:range];
}

◆ setSemanticsNode:

- (void) setSemanticsNode: (const flutter::SemanticsNode*) NS_REQUIRES_SUPER

implementation

Updates this semantics object using data from the node argument.

Reimplemented from SemanticsObject.

Definition at line 20 of file TextInputSemanticsObject.mm.

                        :(const flutter::SemanticsNode*)node {
  [super setSemanticsNode:node];
  _inactive_text_input.text = @(node->value.data());
  FlutterTextInputView* textInput = (FlutterTextInputView*)[self bridge]->textInputView();
  if ([self node].HasFlag(flutter::SemanticsFlags::kIsFocused)) {
    textInput.backingTextInputAccessibilityObject = self;
    // The text input view must have a non-trivial size for the accessibility
    // system to send text editing events.
    textInput.frame = CGRectMake(0.0, 0.0, 1.0, 1.0);
  } else if (textInput.backingTextInputAccessibilityObject == self) {
    textInput.backingTextInputAccessibilityObject = nil;
  }
}

◆ shouldChangeTextInRange:replacementText:

- (BOOL) shouldChangeTextInRange:	(UITextRange*)	range
replacementText:	(NSString*)	text

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                               :(UITextRange*)range replacementText:(NSString*)text {
  return [[self textInputSurrogate] shouldChangeTextInRange:range replacementText:text];
}

◆ textInputSurrogate

- (UIView< UITextInput > *) textInputSurrogate

implementation

The UITextInput whose accessibility properties we present to UIKit as substitutes for Flutter's text field properties.

When the field is currently focused (i.e. it is being edited), we use the FlutterTextInputView used by FlutterTextInputPlugin. Otherwise, we use an FlutterInactiveTextInput.

Definition at line 20 of file TextInputSemanticsObject.mm.

                                           {
  if ([self node].HasFlag(flutter::SemanticsFlags::kIsFocused)) {
    return [self bridge]->textInputView();
  } else {
    return _inactive_text_input;
  }
}

◆ textInputView

- (UIView *) textInputView

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                         {
  return [self textInputSurrogate];
}

◆ textInRange:

- (NSString *) textInRange: (UITextRange*) range

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                        :(UITextRange*)range {
  return [[self textInputSurrogate] textInRange:range];
}

◆ textRangeFromPosition:toPosition:

- (UITextRange *) textRangeFromPosition:	(UITextPosition*)	fromPosition
toPosition:	(UITextPosition*)	toPosition

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                     :(UITextPosition*)fromPosition
                           toPosition:(UITextPosition*)toPosition {
  return [[self textInputSurrogate] textRangeFromPosition:fromPosition toPosition:toPosition];
}

◆ tokenizer

- (id< UITextInputTokenizer >) tokenizer

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                                      {
  return [[self textInputSurrogate] tokenizer];
}

◆ unmarkText

- (void) unmarkText

implementation

Definition at line 20 of file TextInputSemanticsObject.mm.

                   {
  [[self textInputSurrogate] unmarkText];
}

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

shell/platform/darwin/ios/framework/Source/TextInputSemanticsObject.h
shell/platform/darwin/ios/framework/Source/TextInputSemanticsObject.mm

Instance Methods

Additional Inherited Members

Detailed Description

Method Documentation

◆ accessibilityActivate

◆ accessibilityElementDidBecomeFocused

◆ accessibilityElementDidLoseFocus

◆ accessibilityElementIsFocused

◆ accessibilityHint

◆ accessibilityLabel

◆ accessibilityTraits

◆ accessibilityValue

◆ baseWritingDirectionForPosition:inDirection:

◆ beginningOfDocument

◆ caretRectForPosition:

◆ characterRangeAtPoint:

◆ characterRangeByExtendingPosition:inDirection:

◆ closestPositionToPoint:

◆ closestPositionToPoint:withinRange:

◆ comparePosition:toPosition:

◆ deleteBackward

◆ endOfDocument

◆ firstRectForRange:

◆ hasText

◆ initWithBridge:uid:

◆ inputDelegate

◆ insertText:

◆ markedTextRange

◆ markedTextStyle

◆ offsetFromPosition:toPosition:

◆ positionFromPosition:inDirection:offset:

◆ positionFromPosition:offset:

◆ positionWithinRange:farthestInDirection:

◆ replaceRange:withText:

◆ selectedTextRange

◆ selectionAffinity

◆ selectionRectsForRange:

◆ setBaseWritingDirection:forRange:

◆ setInputDelegate:

◆ setMarkedText:selectedRange:

◆ setMarkedTextStyle:

◆ setSelectedTextRange:

◆ setSemanticsNode:

◆ shouldChangeTextInRange:replacementText:

◆ textInputSurrogate

◆ textInputView

◆ textInRange:

◆ textRangeFromPosition:toPosition:

◆ tokenizer

◆ unmarkText