FlutterPlugin.h File Reference

import <UIKit/UIKit.h>
import <UserNotifications/UNUserNotificationCenter.h>
import "FlutterBinaryMessenger.h"
import "FlutterChannels.h"
import "FlutterCodecs.h"
import "FlutterPlatformViews.h"
import "FlutterSceneLifeCycle.h"
import "FlutterTexture.h"

Go to the source code of this file.

Classes
protocol	<FlutterApplicationLifeCycleDelegate>
protocol	<FlutterPlugin>
protocol	<FlutterBaseRegistrar>
protocol	<FlutterApplicationRegistrar>
protocol	<FlutterPluginRegistrar>
protocol	<FlutterPluginRegistry>
protocol	<FlutterPluginRegistrant>
protocol	<FlutterAppLifeCycleProvider>

Typedefs
typedef void(*	FlutterPluginRegistrantCallback) (NSObject< FlutterPluginRegistry > *registry)

Enumerations
enum	FlutterPlatformViewGestureRecognizersBlockingPolicy {   FlutterPlatformViewGestureRecognizersBlockingPolicyEager ,   FlutterPlatformViewGestureRecognizersBlockingPolicyWaitUntilTouchesEnded ,   FlutterPlatformViewGestureRecognizersBlockingPolicyDoNotBlockGesture }

Typedef Documentation

FlutterPluginRegistrantCallback

typedef void(* FlutterPluginRegistrantCallback) (NSObject< FlutterPluginRegistry > *registry)

A plugin registration callback.

Used for registering plugins with additional instances of FlutterPluginRegistry.

Parameters

registry

The registry to register plugins with.

Definition at line 181 of file FlutterPlugin.h.

Enumeration Type Documentation

FlutterPlatformViewGestureRecognizersBlockingPolicy

enum FlutterPlatformViewGestureRecognizersBlockingPolicy

How the UIGestureRecognizers of a platform view are blocked.

UIGestureRecognizers of platform views can be blocked based on decisions made by the Flutter Framework (e.g. When an interact-able widget is covering the platform view).

Enumerator
FlutterPlatformViewGestureRecognizersBlockingPolicyEager	Flutter blocks all the UIGestureRecognizers on the platform view as soon as it decides they should be blocked. This policy employs a dual blocking strategy: synchronous blocking via hitTest results and asynchronous blocking managed through the framework’s gesture arena. With this policy, only the touchesBegan method for all the UIGestureRecognizers is guaranteed to be called.
FlutterPlatformViewGestureRecognizersBlockingPolicyWaitUntilTouchesEnded	Flutter blocks all the UIGestureRecognizers on the platform view only after touchesEnded was invoked. This results in the platform view's UIGestureRecognizers seeing the entire touch sequence, but never recognizing the gesture (and never invoking actions).
FlutterPlatformViewGestureRecognizersBlockingPolicyDoNotBlockGesture	Flutter blocks all the UIGestureRecognizers on the platform view based on results from hitTest. Unlike FlutterPlatformViewGestureRecognizersBlockingPolicyEager, this policy does not rely on Flutter's gesture arena. This is a workaround to address a few bugs related to platform view's gesture recognizers being stuck in a stale state. See: https://github.com/flutter/flutter/issues/175099.

Definition at line 253 of file FlutterPlugin.h.

             {
  // NOLINTBEGIN(readability-identifier-naming)
  /**
   * Flutter blocks all the UIGestureRecognizers on the platform view as soon as it
   * decides they should be blocked.
   *
   * This policy employs a dual blocking strategy: synchronous blocking via hitTest results and
   * asynchronous blocking managed through the framework’s gesture arena. With this policy, only the
   * `touchesBegan` method for all the UIGestureRecognizers is guaranteed to be called.
   */
  FlutterPlatformViewGestureRecognizersBlockingPolicyEager,
  /**
   * Flutter blocks all the UIGestureRecognizers on the platform view only after touchesEnded was
   * invoked.
   *
   * This results in the platform view's UIGestureRecognizers seeing the entire touch sequence,
   * but never recognizing the gesture (and never invoking actions).
   */
  FlutterPlatformViewGestureRecognizersBlockingPolicyWaitUntilTouchesEnded,
  /**
   * Flutter blocks all the UIGestureRecognizers on the platform view based on results from hitTest.
   *
   * Unlike FlutterPlatformViewGestureRecognizersBlockingPolicyEager, this policy does not rely on
   * Flutter's gesture arena. This is a workaround to address a few bugs related to platform view's
   * gesture recognizers being stuck in a stale state. See:
   * https://github.com/flutter/flutter/issues/175099.
   */
  FlutterPlatformViewGestureRecognizersBlockingPolicyDoNotBlockGesture,
  // NOLINTEND(readability-identifier-naming)
} FlutterPlatformViewGestureRecognizersBlockingPolicy;