| Flutter iOS Embedder |

Instance Methods | Properties | List of all members
FlutterViewController() Category Reference

`#import <FlutterViewController_Internal.h>`

Inheritance diagram for FlutterViewController():

## Instance Methods
(UIHoverGestureRecognizer *hoverGestureRecognizer) | - API_AVAILABLE
(UIPanGestureRecognizer *discreteScrollingPanGestureRecognizer) | - API_AVAILABLE
(UIPanGestureRecognizer *continuousScrollingPanGestureRecognizer) | - API_AVAILABLE
(UIPinchGestureRecognizer *pinchGestureRecognizer) | - API_AVAILABLE
(UIRotationGestureRecognizer *rotationGestureRecognizer) | - API_AVAILABLE
(void) | - addInternalPlugins
| Creates and registers plugins used by this view controller. More...
(void) | - deregisterNotifications
(void) | - onFirstFrameRendered
| Called when the first frame has been rendered. Invokes any registered first-frame callback. More...
(void) | - handleKeyboardAnimationCallbackWithTargetTime:
| Handles updating viewport metrics on keyboard animation. More...
(FlutterRestorationPlugin *) | - restorationPlugin
(FlutterTextInputPlugin *) | - textInputPlugin
(void) | - handlePressEvent:nextAction:
(void) | - addInternalPlugins
(void) | - deregisterNotifications
(int32_t) | - accessibilityFlags
(BOOL) | - supportsShowingSystemContextMenu
(BOOL) | - stateIsActive
(BOOL) | - stateIsBackground
Instance Methods inherited from <FlutterBinaryMessenger>
(NSObject< FlutterTaskQueue > *) | - makeBackgroundTaskQueue
| TODO(gaaclarke): Remove optional when macos supports Background Platform Channels. More...
(FlutterBinaryMessengerConnection) | - setMessageHandlerOnChannel:binaryMessageHandler:taskQueue:
(void) | - sendOnChannel:message:
(void) | - sendOnChannel:message:binaryReply:
(FlutterBinaryMessengerConnection) | - setMessageHandlerOnChannel:binaryMessageHandler:
(void) | - cleanUpConnection:
Instance Methods inherited from <FlutterViewResponder>
(void) | - touchesBegan:withEvent:
(void) | - touchesMoved:withEvent:
(void) | - touchesEnded:withEvent:
(void) | - touchesCancelled:withEvent:
(void) | - touchesEstimatedPropertiesUpdated:
(void) | - forceTouchesCancelled:

## Properties
int64_t | viewIdentifier
FlutterView * | flutterView
void(^ | flutterViewRenderedCallback )(void)
UIInterfaceOrientationMask | orientationPreferences
UIStatusBarStyle | statusBarStyle
BOOL | initialized
BOOL | engineNeedsLaunch
BOOL | awokenFromNib
BOOL | displayingFlutterUI
BOOL | isHomeIndicatorHidden
BOOL | isPresentingViewControllerAnimating
BOOL | flutterPrefersStatusBarHidden
NSMutableSet< NSNumber * > * | ongoingTouches
UIScrollView * | scrollView
UIView * | keyboardAnimationView
SpringAnimation * | keyboardSpringAnimation
BOOL | shouldIgnoreViewportMetricsUpdatesDuringRotation
CGFloat | targetViewInsetBottom
CGFloat | originalViewInsetBottom
VSyncClient * | keyboardAnimationVSyncClient
BOOL | keyboardAnimationIsShowing
fml::TimePoint | keyboardAnimationStartTime
BOOL | isKeyboardInOrTransitioningFromBackground
NSTimeInterval | scrollInertiaEventStartline
| Timestamp after which a scroll inertia cancel event should be inferred. More...
NSTimeInterval | scrollInertiaEventAppKitDeadline
VSyncClient * | touchRateCorrectionVSyncClient
CGSize | sizeBeforeAutoResized
BOOL | accessibilityIsOnOffSwitchLabelsEnabled
BOOL | isPresentingViewController
BOOL | isVoiceOverRunning
FlutterKeyboardManager * | keyboardManager
NSString * | applicationLocale
BOOL | prefersStatusBarHidden
| Whether the status bar is preferred hidden. More...
FlutterPlatformViewsController * | platformViewsController
Properties inherited from <FlutterViewResponder>
UIView * | view

## Detailed Description

Definition at line 67 of file FlutterViewController.mm.

## Method Documentation

## ◆ accessibilityFlags

- (int32_t) accessibilityFlags |  |  |

## ◆ addInternalPlugins [1/2]

- (void) addInternalPlugins |  |  |

Creates and registers plugins used by this view controller.

## ◆ addInternalPlugins [2/2]

- (void) addInternalPlugins |  |  |

## ◆ API_AVAILABLE [1/5]

- (UIHoverGestureRecognizer* hoverGestureRecognizer) API_AVAILABLE |  | (ios(13.4)) |  |

## ◆ API_AVAILABLE [2/5]

- (UIPanGestureRecognizer* discreteScrollingPanGestureRecognizer) API_AVAILABLE |  | (ios(13.4)) |  |

## ◆ API_AVAILABLE [3/5]

- (UIPanGestureRecognizer* continuousScrollingPanGestureRecognizer) API_AVAILABLE |  | (ios(13.4)) |  |

## ◆ API_AVAILABLE [4/5]

- (UIPinchGestureRecognizer* pinchGestureRecognizer) API_AVAILABLE |  | (ios(13.4)) |  |

## ◆ API_AVAILABLE [5/5]

- (UIRotationGestureRecognizer* rotationGestureRecognizer) API_AVAILABLE |  | (ios(13.4)) |  |

## ◆ deregisterNotifications [1/2]

- (void) deregisterNotifications |  |  |

## ◆ deregisterNotifications [2/2]

- (void) deregisterNotifications |  |  |

## ◆ handleKeyboardAnimationCallbackWithTargetTime:

- (void) handleKeyboardAnimationCallbackWithTargetTime: |  | (fml::TimePoint) | targetTime |

Handles updating viewport metrics on keyboard animation.

## ◆ handlePressEvent:nextAction:

- (void) handlePressEvent: |  | (FlutterUIPressProxy *) | press
nextAction: |  | (ios(13.4)) | API_AVAILABLE

## ◆ onFirstFrameRendered

- (void) onFirstFrameRendered |  |  |

Called when the first frame has been rendered. Invokes any registered first-frame callback.

## ◆ restorationPlugin

- (FlutterRestorationPlugin*) restorationPlugin |  |  |

## ◆ stateIsActive

- (BOOL) stateIsActive |  |  |

## ◆ stateIsBackground

- (BOOL) stateIsBackground |  |  |

## ◆ supportsShowingSystemContextMenu

- (BOOL) supportsShowingSystemContextMenu |  |  |

## ◆ textInputPlugin

- (FlutterTextInputPlugin*) textInputPlugin |  |  |

## Property Documentation

## ◆ accessibilityIsOnOffSwitchLabelsEnabled

- (BOOL) accessibilityIsOnOffSwitchLabelsEnabled
| read nonatomic assign

Definition at line 47 of file FlutterViewController_Internal.h.

## ◆ applicationLocale

- (NSString*) applicationLocale
| read write nonatomic assign

Definition at line 51 of file FlutterViewController_Internal.h.

## ◆ awokenFromNib

- (BOOL) awokenFromNib
| read write nonatomic assign

Definition at line 82 of file FlutterViewController.mm.

## ◆ displayingFlutterUI

- (BOOL) displayingFlutterUI
| read write nonatomic assign

Definition at line 84 of file FlutterViewController.mm.

## ◆ engineNeedsLaunch

- (BOOL) engineNeedsLaunch
| read write nonatomic assign

Definition at line 81 of file FlutterViewController.mm.

## ◆ flutterPrefersStatusBarHidden

- (BOOL) flutterPrefersStatusBarHidden
| read write nonatomic assign

Definition at line 89 of file FlutterViewController.mm.

## ◆ flutterView

- (FlutterView*) flutterView
| read write nonatomic strong

Definition at line 75 of file FlutterViewController.mm.

## ◆ flutterViewRenderedCallback

- (void(^ flutterViewRenderedCallback) (void))
| read write nonatomic strong

## ◆ initialized

- (BOOL) initialized
| read write nonatomic assign

Definition at line 80 of file FlutterViewController.mm.

## ◆ isHomeIndicatorHidden

- (BOOL) isHomeIndicatorHidden
| read write nonatomic assign

Definition at line 85 of file FlutterViewController.mm.

## ◆ isKeyboardInOrTransitioningFromBackground

- (BOOL) isKeyboardInOrTransitioningFromBackground
| read write nonatomic assign

Definition at line 112 of file FlutterViewController.mm.

## ◆ isPresentingViewController

- (BOOL) isPresentingViewController
| read nonatomic assign

Definition at line 48 of file FlutterViewController_Internal.h.

## ◆ isPresentingViewControllerAnimating

- (BOOL) isPresentingViewControllerAnimating
| read write nonatomic assign

Definition at line 86 of file FlutterViewController.mm.

## ◆ isVoiceOverRunning

- (BOOL) isVoiceOverRunning
| read nonatomic assign

Definition at line 49 of file FlutterViewController_Internal.h.

## ◆ keyboardAnimationIsShowing

- (BOOL) keyboardAnimationIsShowing
| read write nonatomic assign

Definition at line 110 of file FlutterViewController.mm.

## ◆ keyboardAnimationStartTime

- (TimePoint FlutterViewController()):
| read write nonatomic assign

Definition at line 111 of file FlutterViewController.mm.

## ◆ keyboardAnimationView

- (UIView*) keyboardAnimationView
| read write nonatomic strong

Definition at line 97 of file FlutterViewController.mm.

## ◆ keyboardAnimationVSyncClient

- (VSyncClient*) keyboardAnimationVSyncClient
| read write nonatomic strong

Definition at line 109 of file FlutterViewController.mm.

## ◆ keyboardManager

- (FlutterKeyboardManager*) keyboardManager
| read write nonatomic strong

Definition at line 50 of file FlutterViewController_Internal.h.

## ◆ keyboardSpringAnimation

- (SpringAnimation*) keyboardSpringAnimation
| read write nonatomic strong

Definition at line 98 of file FlutterViewController.mm.

## ◆ ongoingTouches

- (NSMutableSet<NSNumber*>*) ongoingTouches
| read write nonatomic strong

Definition at line 91 of file FlutterViewController.mm.

## ◆ orientationPreferences

- (UIInterfaceOrientationMask) orientationPreferences
| read write nonatomic assign

Definition at line 78 of file FlutterViewController.mm.

## ◆ originalViewInsetBottom

- (CGFloat) originalViewInsetBottom
| read write nonatomic assign

Definition at line 108 of file FlutterViewController.mm.

## ◆ platformViewsController

- (FlutterPlatformViewsController*) platformViewsController
| read nonatomic assign

Definition at line 62 of file FlutterViewController_Internal.h.

## ◆ prefersStatusBarHidden

- (BOOL) prefersStatusBarHidden
| read write nonatomic assign

Whether the status bar is preferred hidden.

       This overrides the |UIViewController:prefersStatusBarHidden|.
       This is ignored when `UIViewControllerBasedStatusBarAppearance` in info.plist
       of the app project is `false`.

Definition at line 60 of file FlutterViewController_Internal.h.

## ◆ scrollInertiaEventAppKitDeadline

- (NSTimeInterval) scrollInertiaEventAppKitDeadline
| read write nonatomic assign

When an iOS app is running in emulation on an Apple Silicon Mac, trackpad input goes through a translation layer, and events are not received with precise deltas. Due to this, we can't rely on checking for a stationary trackpad event. Fortunately, AppKit will send an event of type UIEventTypeScroll following a scroll when inertia should stop. This field is needed to estimate if such an event represents the natural end of scrolling inertia or a user-initiated cancellation.

Definition at line 123 of file FlutterViewController.mm.

## ◆ scrollInertiaEventStartline

- (NSTimeInterval) scrollInertiaEventStartline
| read write nonatomic assign

Timestamp after which a scroll inertia cancel event should be inferred.

Definition at line 115 of file FlutterViewController.mm.

## ◆ scrollView

- (UIScrollView*) scrollView
| read write nonatomic strong

Definition at line 96 of file FlutterViewController.mm.

## ◆ shouldIgnoreViewportMetricsUpdatesDuringRotation

- (BOOL) shouldIgnoreViewportMetricsUpdatesDuringRotation
| read write nonatomic assign

Whether we should ignore viewport metrics updates during rotation transition.

Definition at line 103 of file FlutterViewController.mm.

## ◆ sizeBeforeAutoResized

- (CGSize) sizeBeforeAutoResized
| read write nonatomic assign

The size of the FlutterView's frame, as determined by auto-layout, before Flutter's custom auto-resizing constraints are applied.

Definition at line 135 of file FlutterViewController.mm.

## ◆ statusBarStyle

- (UIStatusBarStyle) statusBarStyle
| read write nonatomic assign

Definition at line 79 of file FlutterViewController.mm.

## ◆ targetViewInsetBottom

- (CGFloat) targetViewInsetBottom
| read write nonatomic assign

Keyboard animation properties

Definition at line 107 of file FlutterViewController.mm.

## ◆ touchRateCorrectionVSyncClient

- (VSyncClient*) touchRateCorrectionVSyncClient
| read write nonatomic strong

VSyncClient for touch events delivery frame rate correction.

On promotion devices(eg: iPhone13 Pro), the delivery frame rate of touch events is 60HZ but the frame rate of rendering is 120HZ, which is different and will leads jitter and laggy. With this VSyncClient, it can correct the delivery frame rate of touch events to let it keep the same with frame rate of rendering.

Definition at line 131 of file FlutterViewController.mm.

## ◆ viewIdentifier

- (int64_t) viewIdentifier
| read nonatomic assign

Definition at line 71 of file FlutterViewController.mm.

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

- shell/platform/darwin/ios/framework/Source/FlutterViewController.mm
- shell/platform/darwin/ios/framework/Source/FlutterViewController_Internal.h