FlutterSpellCheckPlugin Class Reference

#import <FlutterSpellCheckPlugin.h>

Inheritance diagram for FlutterSpellCheckPlugin:

Instance Methods
(void)	- handleMethodCall:result:
(NSArray< NSDictionary< NSString *, id > * > *)	- findAllSpellCheckSuggestionsForText:inLanguage: [implementation]
(FlutterSpellCheckResult *)	- findSpellCheckSuggestionsForText:inLanguage:startingOffset: [implementation]
(UITextChecker *)	- textChecker [implementation]

Properties
UITextChecker *	textChecker [implementation]

Detailed Description

Definition at line 11 of file FlutterSpellCheckPlugin.h.

Method Documentation

findAllSpellCheckSuggestionsForText:inLanguage:

- (NSArray< NSDictionary< NSString *, id > * > *) findAllSpellCheckSuggestionsForText: (NSString*)  text inLanguage: (NSString*)  language

implementation

Definition at line 32 of file FlutterSpellCheckPlugin.mm.

                                                                             :(NSString*)text
                                                                   inLanguage:(NSString*)language {
  // Transform Dart Locale format to iOS language format if necessary.
  if ([language containsString:@"-"]) {
    NSArray<NSString*>* languageCodes = [language componentsSeparatedByString:@"-"];
    FML_DCHECK(languageCodes.count == 2);
    NSString* lastCode = [[languageCodes lastObject] uppercaseString];
    language = [NSString stringWithFormat:@"%@_%@", [languageCodes firstObject], lastCode];
  }
 
  if (![UITextChecker.availableLanguages containsObject:language]) {
    return nil;
  }
 
  NSMutableArray<FlutterSpellCheckResult*>* allSpellSuggestions = [[NSMutableArray alloc] init];
 
  FlutterSpellCheckResult* nextSpellSuggestion;
  NSUInteger nextOffset = 0;
  do {
    nextSpellSuggestion = [self findSpellCheckSuggestionsForText:text
                                                      inLanguage:language
                                                  startingOffset:nextOffset];
    if (nextSpellSuggestion != nil) {
      [allSpellSuggestions addObject:nextSpellSuggestion];
      nextOffset =
          nextSpellSuggestion.misspelledRange.location + nextSpellSuggestion.misspelledRange.length;
    }
  } while (nextSpellSuggestion != nil && nextOffset < text.length);
 
  NSMutableArray* methodChannelResult =
      [[NSMutableArray alloc] initWithCapacity:allSpellSuggestions.count];
 
  for (FlutterSpellCheckResult* result in allSpellSuggestions) {
    [methodChannelResult addObject:[result toDictionary]];
  }
 
  return methodChannelResult;
}

findSpellCheckSuggestionsForText:inLanguage:startingOffset:

- (FlutterSpellCheckResult *) findSpellCheckSuggestionsForText: (NSString*)  text inLanguage: (NSString*)  language startingOffset: (NSInteger)  startingOffset

implementation

Definition at line 32 of file FlutterSpellCheckPlugin.mm.

                                                            :(NSString*)text
                                                  inLanguage:(NSString*)language
                                              startingOffset:(NSInteger)startingOffset {
  FML_DCHECK([UITextChecker.availableLanguages containsObject:language]);
  NSRange misspelledRange =
      [self.textChecker rangeOfMisspelledWordInString:text
                                                range:NSMakeRange(0, text.length)
                                           startingAt:startingOffset
                                                 wrap:NO
                                             language:language];
  if (misspelledRange.location == NSNotFound) {
    // No misspelled word found
    return nil;
  }
 
  // If no possible guesses, the API returns an empty array:
  // https://developer.apple.com/documentation/uikit/uitextchecker/1621037-guessesforwordrange?language=objc
  NSArray<NSString*>* suggestions = [self.textChecker guessesForWordRange:misspelledRange
                                                                 inString:text
                                                                 language:language];
  return [[FlutterSpellCheckResult alloc] initWithMisspelledRange:misspelledRange
                                                      suggestions:suggestions];
}

handleMethodCall:result:

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

Definition at line 32 of file FlutterSpellCheckPlugin.mm.

                        :(FlutterMethodCall*)call result:(FlutterResult)result {
  if (!self.textChecker) {
    // UITextChecker is an expensive object to initiate, see:
    // https://github.com/flutter/flutter/issues/104454. Lazily initialate the UITextChecker object
    // until at first method channel call. We avoid using lazy getter for testing.
    self.textChecker = [[UITextChecker alloc] init];
  }
  NSString* method = call.method;
  NSArray* args = call.arguments;
  if ([method isEqualToString:kInitiateSpellCheck]) {
    FML_DCHECK(args.count == 2);
    id language = args[0];
    id text = args[1];
    if (language == [NSNull null] || text == [NSNull null]) {
      // Bail if null arguments are passed from dart.
      result(nil);
      return;
    }
 
    NSArray<NSDictionary<NSString*, id>*>* spellCheckResult =
        [self findAllSpellCheckSuggestionsForText:text inLanguage:language];
    result(spellCheckResult);
  }
}

textChecker

- (UITextChecker *) textChecker

implementation

Property Documentation

textChecker

- (UITextChecker*) textChecker

readwritenonatomicassignimplementation

Definition at line 32 of file FlutterSpellCheckPlugin.mm.

---

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

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