FlutterPlatformPlugin Class Reference

#include <FlutterPlatformPlugin.h>

Inheritance diagram for FlutterPlatformPlugin:

Instance Methods
(instancetype)	- NS_UNAVAILABLE
(instancetype)	- initWithEngine:
(void)	- handleMethodCall:result:
(instancetype)	- initWithEngine: [implementation]
(void)	- showSystemContextMenu: [implementation]
(void)	- hideSystemContextMenu [implementation]
(void)	- showShareViewController: [implementation]
(void)	- searchWeb: [implementation]
(void)	- playSystemSound: [implementation]
(void)	- vibrateHapticFeedback: [implementation]
(void)	- setSystemChromePreferredOrientations: [implementation]
(void)	- setSystemChromeApplicationSwitcherDescription: [implementation]
(void)	- setSystemChromeEnabledSystemUIOverlays: [implementation]
(void)	- setSystemChromeEnabledSystemUIMode: [implementation]
(void)	- restoreSystemChromeSystemUIOverlays [implementation]
(void)	- setSystemChromeSystemUIOverlayStyle: [implementation]
(void)	- popSystemNavigator: [implementation]
(NSDictionary *)	- getClipboardData: [implementation]
(void)	- setClipboardData: [implementation]
(NSDictionary *)	- clipboardHasStrings [implementation]
(BOOL)	- isLiveTextInputAvailable [implementation]
(void)	- showLookUpViewController: [implementation]
(UITextField *)	- textField [implementation]
(void)	- dealloc [implementation]

Class Methods
(instancetype)	+ NS_UNAVAILABLE

Properties
BOOL	enableViewControllerBasedStatusBarAppearance [implementation]
	Whether the status bar appearance is based on the style preferred for this ViewController.

Detailed Description

Definition at line 12 of file FlutterPlatformPlugin.h.

Method Documentation

clipboardHasStrings

- (NSDictionary *) clipboardHasStrings

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                                     {
  return @{@"value" : @([UIPasteboard generalPasteboard].hasStrings)};
}

dealloc

- (void) dealloc

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                {
  [_textField release];
  [super dealloc];
}

getClipboardData:

- (NSDictionary *) getClipboardData: (NSString*)  format

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                                 :(NSString*)format {
  UIPasteboard* pasteboard = [UIPasteboard generalPasteboard];
  if (!format || [format isEqualToString:@(kTextPlainFormat)]) {
    NSString* stringInPasteboard = pasteboard.string;
    // The pasteboard may contain an item but it may not be a string (an image for instance).
    return stringInPasteboard == nil ? nil : @{@"text" : stringInPasteboard};
  }
  return nil;
}

handleMethodCall:result:

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

Definition at line 79 of file FlutterPlatformPlugin.mm.

                        :(FlutterMethodCall*)call result:(FlutterResult)result {
  NSString* method = call.method;
  id args = call.arguments;
  if ([method isEqualToString:@"SystemSound.play"]) {
    [self playSystemSound:args];
    result(nil);
  } else if ([method isEqualToString:@"HapticFeedback.vibrate"]) {
    [self vibrateHapticFeedback:args];
    result(nil);
  } else if ([method isEqualToString:@"SystemChrome.setPreferredOrientations"]) {
    [self setSystemChromePreferredOrientations:args];
    result(nil);
  } else if ([method isEqualToString:@"SystemChrome.setApplicationSwitcherDescription"]) {
    [self setSystemChromeApplicationSwitcherDescription:args];
    result(nil);
  } else if ([method isEqualToString:@"SystemChrome.setEnabledSystemUIOverlays"]) {
    [self setSystemChromeEnabledSystemUIOverlays:args];
    result(nil);
  } else if ([method isEqualToString:@"SystemChrome.setEnabledSystemUIMode"]) {
    [self setSystemChromeEnabledSystemUIMode:args];
    result(nil);
  } else if ([method isEqualToString:@"SystemChrome.restoreSystemUIOverlays"]) {
    [self restoreSystemChromeSystemUIOverlays];
    result(nil);
  } else if ([method isEqualToString:@"SystemChrome.setSystemUIOverlayStyle"]) {
    [self setSystemChromeSystemUIOverlayStyle:args];
    result(nil);
  } else if ([method isEqualToString:@"SystemNavigator.pop"]) {
    NSNumber* isAnimated = args;
    [self popSystemNavigator:isAnimated.boolValue];
    result(nil);
  } else if ([method isEqualToString:@"Clipboard.getData"]) {
    result([self getClipboardData:args]);
  } else if ([method isEqualToString:@"Clipboard.setData"]) {
    [self setClipboardData:args];
    result(nil);
  } else if ([method isEqualToString:@"Clipboard.hasStrings"]) {
    result([self clipboardHasStrings]);
  } else if ([method isEqualToString:@"LiveText.isLiveTextInputAvailable"]) {
    result(@([self isLiveTextInputAvailable]));
  } else if ([method isEqualToString:@"SearchWeb.invoke"]) {
    [self searchWeb:args];
    result(nil);
  } else if ([method isEqualToString:@"LookUp.invoke"]) {
    [self showLookUpViewController:args];
    result(nil);
  } else if ([method isEqualToString:@"Share.invoke"]) {
    [self showShareViewController:args];
    result(nil);
  } else if ([method isEqualToString:@"ContextMenu.showSystemContextMenu"]) {
    [self showSystemContextMenu:args];
    result(nil);
  } else if ([method isEqualToString:@"ContextMenu.hideSystemContextMenu"]) {
    [self hideSystemContextMenu];
    result(nil);
  } else {
    result(FlutterMethodNotImplemented);
  }
}

hideSystemContextMenu

- (void) hideSystemContextMenu

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                              {
  if (@available(iOS 16.0, *)) {
    FlutterTextInputPlugin* textInputPlugin = [_engine.get() textInputPlugin];
    [textInputPlugin hideEditMenu];
  }
}

initWithEngine: [1/2]

- (instancetype) initWithEngine: (fml::WeakNSObject<FlutterEngine>)  engine

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                              :(fml::WeakNSObject<FlutterEngine>)engine {
  FML_DCHECK(engine) << "engine must be set";
  self = [super init];
 
  if (self) {
    _engine = engine;
    NSObject* infoValue = [[NSBundle mainBundle]
        objectForInfoDictionaryKey:@"UIViewControllerBasedStatusBarAppearance"];
#if FLUTTER_RUNTIME_MODE == FLUTTER_RUNTIME_MODE_DEBUG
    if (infoValue != nil && ![infoValue isKindOfClass:[NSNumber class]]) {
      FML_LOG(ERROR) << "The value of UIViewControllerBasedStatusBarAppearance in info.plist must "
                        "be a Boolean type.";
    }
#endif
    _enableViewControllerBasedStatusBarAppearance =
        (infoValue == nil || [(NSNumber*)infoValue boolValue]);
  }
 
  return self;
}

initWithEngine: [2/2]

- (instancetype) initWithEngine:

(fml::WeakNSObject< FlutterEngine >)

NS_DESIGNATED_INITIALIZER

isLiveTextInputAvailable

- (BOOL) isLiveTextInputAvailable

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                                 {
  return [[self textField] canPerformAction:@selector(captureTextFromCamera:) withSender:nil];
}

NS_UNAVAILABLE [1/2]

+ (instancetype) NS_UNAVAILABLE

NS_UNAVAILABLE [2/2]

- (instancetype) NS_UNAVAILABLE

playSystemSound:

- (void) playSystemSound: (NSString*)  soundType

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                       :(NSString*)soundType {
  if ([soundType isEqualToString:@"SystemSoundType.click"]) {
    // All feedback types are specific to Android and are treated as equal on
    // iOS.
    AudioServicesPlaySystemSound(kKeyPressClickSoundId);
  }
}

popSystemNavigator:

- (void) popSystemNavigator: (BOOL)  isAnimated

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                          :(BOOL)isAnimated {
  // Apple's human user guidelines say not to terminate iOS applications. However, if the
  // root view of the app is a navigation controller, it is instructed to back up a level
  // in the navigation hierarchy.
  // It's also possible in an Add2App scenario that the FlutterViewController was presented
  // outside the context of a UINavigationController, and still wants to be popped.
 
  FlutterViewController* engineViewController = [_engine.get() viewController];
  UINavigationController* navigationController = [engineViewController navigationController];
  if (navigationController) {
    [navigationController popViewControllerAnimated:isAnimated];
  } else {
    UIViewController* rootViewController = nil;
#if APPLICATION_EXTENSION_API_ONLY
    if (@available(iOS 15.0, *)) {
      rootViewController =
          [engineViewController flutterWindowSceneIfViewLoaded].keyWindow.rootViewController;
    } else {
      FML_LOG(WARNING)
          << "rootViewController is not available in application extension prior to iOS 15.0.";
    }
#else
    rootViewController = [UIApplication sharedApplication].keyWindow.rootViewController;
#endif
    if (engineViewController != rootViewController) {
      [engineViewController dismissViewControllerAnimated:isAnimated completion:nil];
    }
  }
}

restoreSystemChromeSystemUIOverlays

- (void) restoreSystemChromeSystemUIOverlays

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                                            {
  // Nothing to do on iOS.
}

searchWeb:

- (void) searchWeb: (NSString*)  searchTerm

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                 :(NSString*)searchTerm {
#if APPLICATION_EXTENSION_API_ONLY
  FML_LOG(WARNING) << "SearchWeb.invoke is not availabe in app extension.";
#else
  NSString* escapedText = [searchTerm
      stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet
                                                             URLHostAllowedCharacterSet]];
  NSString* searchURL = [NSString stringWithFormat:@"%@%@", searchURLPrefix, escapedText];
 
  [[UIApplication sharedApplication] openURL:[NSURL URLWithString:searchURL]
                                     options:@{}
                           completionHandler:nil];
#endif
}

setClipboardData:

- (void) setClipboardData: (NSDictionary*)  data

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                        :(NSDictionary*)data {
  UIPasteboard* pasteboard = [UIPasteboard generalPasteboard];
  id copyText = data[@"text"];
  if ([copyText isKindOfClass:[NSString class]]) {
    pasteboard.string = copyText;
  } else {
    pasteboard.string = @"null";
  }
}

setSystemChromeApplicationSwitcherDescription:

- (void) setSystemChromeApplicationSwitcherDescription: (NSDictionary*)  object

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                                                     :(NSDictionary*)object {
  // No counterpart on iOS but is a benign operation. So no asserts.
}

setSystemChromeEnabledSystemUIMode:

- (void) setSystemChromeEnabledSystemUIMode: (NSString*)  mode

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                                          :(NSString*)mode {
  BOOL edgeToEdge = [mode isEqualToString:@"SystemUiMode.edgeToEdge"];
  if (self.enableViewControllerBasedStatusBarAppearance) {
    [_engine.get() viewController].prefersStatusBarHidden = !edgeToEdge;
  } else {
    // Checks if the top status bar should be visible, reflected by edge to edge setting. This
    // platform ignores all other system ui modes.
 
    // We opt out of view controller based status bar visibility since we want
    // to be able to modify this on the fly. The key used is
    // UIViewControllerBasedStatusBarAppearance.
    SetStatusBarHiddenForSharedApplication(!edgeToEdge);
  }
  [[NSNotificationCenter defaultCenter]
      postNotificationName:edgeToEdge ? FlutterViewControllerShowHomeIndicator
                                      : FlutterViewControllerHideHomeIndicator
                    object:nil];
}

setSystemChromeEnabledSystemUIOverlays:

- (void) setSystemChromeEnabledSystemUIOverlays: (NSArray*)  overlays

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                                              :(NSArray*)overlays {
  BOOL statusBarShouldBeHidden = ![overlays containsObject:@"SystemUiOverlay.top"];
  if ([overlays containsObject:@"SystemUiOverlay.bottom"]) {
    [[NSNotificationCenter defaultCenter]
        postNotificationName:FlutterViewControllerShowHomeIndicator
                      object:nil];
  } else {
    [[NSNotificationCenter defaultCenter]
        postNotificationName:FlutterViewControllerHideHomeIndicator
                      object:nil];
  }
  if (self.enableViewControllerBasedStatusBarAppearance) {
    [_engine.get() viewController].prefersStatusBarHidden = statusBarShouldBeHidden;
  } else {
    // Checks if the top status bar should be visible. This platform ignores all
    // other overlays
 
    // We opt out of view controller based status bar visibility since we want
    // to be able to modify this on the fly. The key used is
    // UIViewControllerBasedStatusBarAppearance.
    SetStatusBarHiddenForSharedApplication(statusBarShouldBeHidden);
  }
}

setSystemChromePreferredOrientations:

- (void) setSystemChromePreferredOrientations: (NSArray*)  orientations

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                                            :(NSArray*)orientations {
  UIInterfaceOrientationMask mask = 0;
 
  if (orientations.count == 0) {
    mask |= UIInterfaceOrientationMaskAll;
  } else {
    for (NSString* orientation in orientations) {
      if ([orientation isEqualToString:@"DeviceOrientation.portraitUp"]) {
        mask |= UIInterfaceOrientationMaskPortrait;
      } else if ([orientation isEqualToString:@"DeviceOrientation.portraitDown"]) {
        mask |= UIInterfaceOrientationMaskPortraitUpsideDown;
      } else if ([orientation isEqualToString:@"DeviceOrientation.landscapeLeft"]) {
        mask |= UIInterfaceOrientationMaskLandscapeLeft;
      } else if ([orientation isEqualToString:@"DeviceOrientation.landscapeRight"]) {
        mask |= UIInterfaceOrientationMaskLandscapeRight;
      }
    }
  }
 
  if (!mask) {
    return;
  }
  [[NSNotificationCenter defaultCenter]
      postNotificationName:@(kOrientationUpdateNotificationName)
                    object:nil
                  userInfo:@{@(kOrientationUpdateNotificationKey) : @(mask)}];
}

setSystemChromeSystemUIOverlayStyle:

- (void) setSystemChromeSystemUIOverlayStyle: (NSDictionary*)  message

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                                           :(NSDictionary*)message {
  NSString* brightness = message[@"statusBarBrightness"];
  if (brightness == (id)[NSNull null]) {
    return;
  }
 
  UIStatusBarStyle statusBarStyle;
  if ([brightness isEqualToString:@"Brightness.dark"]) {
    statusBarStyle = UIStatusBarStyleLightContent;
  } else if ([brightness isEqualToString:@"Brightness.light"]) {
    if (@available(iOS 13, *)) {
      statusBarStyle = UIStatusBarStyleDarkContent;
    } else {
      statusBarStyle = UIStatusBarStyleDefault;
    }
  } else {
    return;
  }
 
  if (self.enableViewControllerBasedStatusBarAppearance) {
    // This notification is respected by the iOS embedder.
    [[NSNotificationCenter defaultCenter]
        postNotificationName:@(kOverlayStyleUpdateNotificationName)
                      object:nil
                    userInfo:@{@(kOverlayStyleUpdateNotificationKey) : @(statusBarStyle)}];
  } else {
    SetStatusBarStyleForSharedApplication(statusBarStyle);
  }
}

showLookUpViewController:

- (void) showLookUpViewController: (NSString*)  term

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                                :(NSString*)term {
  UIViewController* engineViewController = [_engine.get() viewController];
  UIReferenceLibraryViewController* referenceLibraryViewController =
      [[[UIReferenceLibraryViewController alloc] initWithTerm:term] autorelease];
  [engineViewController presentViewController:referenceLibraryViewController
                                     animated:YES
                                   completion:nil];
}

showShareViewController:

- (void) showShareViewController: (NSString*)  content

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                               :(NSString*)content {
  UIViewController* engineViewController = [_engine.get() viewController];
 
  NSArray* itemsToShare = @[ content ?: [NSNull null] ];
  UIActivityViewController* activityViewController =
      [[[UIActivityViewController alloc] initWithActivityItems:itemsToShare
                                         applicationActivities:nil] autorelease];
 
  if (UI_USER_INTERFACE_IDIOM() == UIUserInterfaceIdiomPad) {
    // On iPad, the share screen is presented in a popover view, and requires a
    // sourceView and sourceRect
    FlutterTextInputPlugin* _textInputPlugin = [_engine.get() textInputPlugin];
    UITextRange* range = _textInputPlugin.textInputView.selectedTextRange;
 
    // firstRectForRange cannot be used here as it's current implementation does
    // not always return the full rect of the range.
    CGRect firstRect = [(FlutterTextInputView*)_textInputPlugin.textInputView
        caretRectForPosition:(FlutterTextPosition*)range.start];
    CGRect transformedFirstRect = [(FlutterTextInputView*)_textInputPlugin.textInputView
        localRectFromFrameworkTransform:firstRect];
    CGRect lastRect = [(FlutterTextInputView*)_textInputPlugin.textInputView
        caretRectForPosition:(FlutterTextPosition*)range.end];
    CGRect transformedLastRect = [(FlutterTextInputView*)_textInputPlugin.textInputView
        localRectFromFrameworkTransform:lastRect];
 
    activityViewController.popoverPresentationController.sourceView = engineViewController.view;
    // In case of RTL Language, get the minimum x coordinate
    activityViewController.popoverPresentationController.sourceRect =
        CGRectMake(fmin(transformedFirstRect.origin.x, transformedLastRect.origin.x),
                   transformedFirstRect.origin.y,
                   abs(transformedLastRect.origin.x - transformedFirstRect.origin.x),
                   transformedFirstRect.size.height);
  }
 
  [engineViewController presentViewController:activityViewController animated:YES completion:nil];
}

showSystemContextMenu:

- (void) showSystemContextMenu: (NSDictionary*)  args

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                             :(NSDictionary*)args {
  if (@available(iOS 16.0, *)) {
    FlutterTextInputPlugin* textInputPlugin = [_engine.get() textInputPlugin];
    BOOL shownEditMenu = [textInputPlugin showEditMenu:args];
    if (!shownEditMenu) {
      FML_LOG(ERROR) << "Only text input supports system context menu for now. Ensure the system "
                        "context menu is shown with an active text input connection. See "
                        "https://github.com/flutter/flutter/issues/143033.";
    }
  }
}

textField

- (UITextField *) textField

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                          {
  if (_textField == nil) {
    _textField = [[UITextField alloc] init];
  }
  return _textField;
}

vibrateHapticFeedback:

- (void) vibrateHapticFeedback: (NSString*)  feedbackType

implementation

Definition at line 79 of file FlutterPlatformPlugin.mm.

                             :(NSString*)feedbackType {
  if (!feedbackType) {
    AudioServicesPlaySystemSound(kSystemSoundID_Vibrate);
    return;
  }
 
  if ([@"HapticFeedbackType.lightImpact" isEqualToString:feedbackType]) {
    [[[[UIImpactFeedbackGenerator alloc] initWithStyle:UIImpactFeedbackStyleLight] autorelease]
        impactOccurred];
  } else if ([@"HapticFeedbackType.mediumImpact" isEqualToString:feedbackType]) {
    [[[[UIImpactFeedbackGenerator alloc] initWithStyle:UIImpactFeedbackStyleMedium] autorelease]
        impactOccurred];
  } else if ([@"HapticFeedbackType.heavyImpact" isEqualToString:feedbackType]) {
    [[[[UIImpactFeedbackGenerator alloc] initWithStyle:UIImpactFeedbackStyleHeavy] autorelease]
        impactOccurred];
  } else if ([@"HapticFeedbackType.selectionClick" isEqualToString:feedbackType]) {
    [[[[UISelectionFeedbackGenerator alloc] init] autorelease] selectionChanged];
  }
}

Property Documentation

enableViewControllerBasedStatusBarAppearance

- (BOOL) enableViewControllerBasedStatusBarAppearance

readwritenonatomicassignimplementation

Whether the status bar appearance is based on the style preferred for this ViewController.

   The default value is YES.
   Explicitly add `UIViewControllerBasedStatusBarAppearance` as `false` in
   info.plist makes this value to be false.

Provided by category FlutterPlatformPlugin().

Definition at line 72 of file FlutterPlatformPlugin.mm.

---

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

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