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

#import <FlutterViewController_Internal.h>

Inheritance diagram for FlutterViewController():
<FlutterBinaryMessenger>

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
 
(void) - handlePressEvent:nextAction:
 
(void) - sendDeepLinkToFramework:completionHandler:
 
(void) - addInternalPlugins
 
(void) - deregisterNotifications
 
(int32_t) - accessibilityFlags
 
(BOOL) - supportsShowingSystemContextMenu
 
- 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:
 

Properties

int64_t viewIdentifier
 
FlutterView * flutterView
 
void(^ flutterViewRenderedCallback )(void)
 
UIInterfaceOrientationMask orientationPreferences
 
UIStatusBarStyle statusBarStyle
 
BOOL initialized
 
BOOL engineNeedsLaunch
 
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
 
BOOL accessibilityIsOnOffSwitchLabelsEnabled
 
BOOL isPresentingViewController
 
BOOL isVoiceOverRunning
 
FlutterKeyboardManager * keyboardManager
 
BOOL prefersStatusBarHidden
 Whether the status bar is preferred hidden. More...
 
FlutterPlatformViewsController * platformViewsController
 

Detailed Description

Definition at line 62 of file FlutterViewController.mm.

Method Documentation

◆ accessibilityFlags

- (int32_t) accessibilityFlags

◆ addInternalPlugins [1/2]

- (void) addInternalPlugins

◆ addInternalPlugins [2/2]

- (void) addInternalPlugins

Creates and registers plugins used by this view controller.

◆ 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

◆ sendDeepLinkToFramework:completionHandler:

- (void) sendDeepLinkToFramework: (NSURL *)  url
completionHandler: (void(^)(BOOL success))  completion 

◆ supportsShowingSystemContextMenu

- (BOOL) supportsShowingSystemContextMenu

Property Documentation

◆ accessibilityIsOnOffSwitchLabelsEnabled

- (BOOL) accessibilityIsOnOffSwitchLabelsEnabled
readnonatomicassign

Definition at line 46 of file FlutterViewController_Internal.h.

◆ displayingFlutterUI

- (BOOL) displayingFlutterUI
readwritenonatomicassign

Definition at line 78 of file FlutterViewController.mm.

◆ engineNeedsLaunch

- (BOOL) engineNeedsLaunch
readwritenonatomicassign

Definition at line 76 of file FlutterViewController.mm.

◆ flutterPrefersStatusBarHidden

- (BOOL) flutterPrefersStatusBarHidden
readwritenonatomicassign

Definition at line 83 of file FlutterViewController.mm.

◆ flutterView

- (FlutterView*) flutterView
readwritenonatomicstrong

Definition at line 70 of file FlutterViewController.mm.

◆ flutterViewRenderedCallback

- (void(^ flutterViewRenderedCallback) (void))
readwritenonatomicstrong

◆ initialized

- (BOOL) initialized
readwritenonatomicassign

Definition at line 75 of file FlutterViewController.mm.

◆ isHomeIndicatorHidden

- (BOOL) isHomeIndicatorHidden
readwritenonatomicassign

Definition at line 79 of file FlutterViewController.mm.

◆ isKeyboardInOrTransitioningFromBackground

- (BOOL) isKeyboardInOrTransitioningFromBackground
readwritenonatomicassign

Definition at line 107 of file FlutterViewController.mm.

◆ isPresentingViewController

- (BOOL) isPresentingViewController
readnonatomicassign

Definition at line 47 of file FlutterViewController_Internal.h.

◆ isPresentingViewControllerAnimating

- (BOOL) isPresentingViewControllerAnimating
readwritenonatomicassign

Definition at line 80 of file FlutterViewController.mm.

◆ isVoiceOverRunning

- (BOOL) isVoiceOverRunning
readnonatomicassign

Definition at line 48 of file FlutterViewController_Internal.h.

◆ keyboardAnimationIsShowing

- (BOOL) keyboardAnimationIsShowing
readwritenonatomicassign

Definition at line 105 of file FlutterViewController.mm.

◆ keyboardAnimationStartTime

- (TimePoint FlutterViewController()):
readwritenonatomicassign

Definition at line 106 of file FlutterViewController.mm.

◆ keyboardAnimationView

- (UIView*) keyboardAnimationView
readwritenonatomicstrong

Definition at line 91 of file FlutterViewController.mm.

◆ keyboardAnimationVSyncClient

- (VSyncClient*) keyboardAnimationVSyncClient
readwritenonatomicstrong

Definition at line 104 of file FlutterViewController.mm.

◆ keyboardManager

- (FlutterKeyboardManager*) keyboardManager
readwritenonatomicstrong

Definition at line 49 of file FlutterViewController_Internal.h.

◆ keyboardSpringAnimation

- (SpringAnimation*) keyboardSpringAnimation
readwritenonatomicstrong

Definition at line 92 of file FlutterViewController.mm.

◆ ongoingTouches

- (NSMutableSet<NSNumber*>*) ongoingTouches
readwritenonatomicstrong

Definition at line 85 of file FlutterViewController.mm.

◆ orientationPreferences

- (UIInterfaceOrientationMask) orientationPreferences
readwritenonatomicassign

Definition at line 73 of file FlutterViewController.mm.

◆ originalViewInsetBottom

- (CGFloat) originalViewInsetBottom
readwritenonatomicassign

Definition at line 103 of file FlutterViewController.mm.

◆ platformViewsController

- (FlutterPlatformViewsController*) platformViewsController
readnonatomicassign

Definition at line 60 of file FlutterViewController_Internal.h.

◆ prefersStatusBarHidden

- (BOOL) prefersStatusBarHidden
readwritenonatomicassign

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 58 of file FlutterViewController_Internal.h.

◆ scrollInertiaEventAppKitDeadline

- (NSTimeInterval) scrollInertiaEventAppKitDeadline
readwritenonatomicassign

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 118 of file FlutterViewController.mm.

◆ scrollInertiaEventStartline

- (NSTimeInterval) scrollInertiaEventStartline
readwritenonatomicassign

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

Definition at line 110 of file FlutterViewController.mm.

◆ scrollView

- (UIScrollView*) scrollView
readwritenonatomicstrong

Definition at line 90 of file FlutterViewController.mm.

◆ shouldIgnoreViewportMetricsUpdatesDuringRotation

- (BOOL) shouldIgnoreViewportMetricsUpdatesDuringRotation
readwritenonatomicassign

Whether we should ignore viewport metrics updates during rotation transition.

Definition at line 97 of file FlutterViewController.mm.

◆ statusBarStyle

- (UIStatusBarStyle) statusBarStyle
readwritenonatomicassign

Definition at line 74 of file FlutterViewController.mm.

◆ targetViewInsetBottom

- (CGFloat) targetViewInsetBottom
readwritenonatomicassign

Keyboard animation properties

Definition at line 102 of file FlutterViewController.mm.

◆ touchRateCorrectionVSyncClient

- (VSyncClient*) touchRateCorrectionVSyncClient
readwritenonatomicstrong

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 126 of file FlutterViewController.mm.

◆ viewIdentifier

- (int64_t) viewIdentifier
readnonatomicassign

Definition at line 66 of file FlutterViewController.mm.

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