FlutterViewController
@interface FlutterViewController
: UIViewController <FlutterBinaryMessenger, FlutterTextureRegistry,
FlutterPluginRegistry>
A UIViewController
implementation for Flutter views.
Dart execution, channel communication, texture registration, and plugin registration
are all handled by FlutterEngine
. Calls on this class to those members all proxy
through to the FlutterEngine
attached FlutterViewController.
A FlutterViewController can be initialized either with an already-running FlutterEngine
,
or it can be initialized with a FlutterDartProject
that will be used to spin up
a new FlutterEngine
. Developers looking to present and hide FlutterViewControllers
in native iOS applications will usually want to maintain the FlutterEngine
instance
so as not to lose Dart-related state and asynchronous tasks when navigating back and
forth between a FlutterViewController and other UIViewController
s.
-
Initializes this FlutterViewController with the specified
FlutterEngine
.The initialized viewcontroller will attach itself to the engine as part of this process.
Declaration
Objective-C
- (instancetype)initWithEngine:(FlutterEngine *)engine nibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil;
Parameters
engine
The
FlutterEngine
instance to attach to.nibNameOrNil
The NIB name to initialize this UIViewController with.
nibBundleOrNil
The NIB bundle.
-
Initializes a new FlutterViewController and
FlutterEngine
with the specifiedFlutterDartProject
.Declaration
Objective-C
- (instancetype)initWithProject:(FlutterDartProject *)projectOrNil nibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil;
Parameters
projectOrNil
The
FlutterDartProject
to initialize theFlutterEngine
with.nibNameOrNil
The NIB name to initialize this UIViewController with.
nibBundleOrNil
The NIB bundle.
-
Undocumented
Declaration
Objective-C
- (void)handleStatusBarTouches:(UIEvent*)event;
-
Registers a callback that will be invoked when the Flutter view has been rendered. The callback will be fired only once.
Replaces an existing callback. Use a
nil
callback to unregister the existing one.Declaration
Objective-C
- (void)setFlutterViewDidRenderCallback:(void (^)(void))callback;
-
Returns the file name for the given asset. The returned file name can be used to access the asset in the application’s main bundle.
Declaration
Objective-C
- (NSString *)lookupKeyForAsset:(NSString *)asset;
Parameters
asset
The name of the asset. The name can be hierarchical.
Return Value
The file name to be used for lookup in the main bundle.
-
Returns the file name for the given asset which originates from the specified package. The returned file name can be used to access the asset in the application’s main bundle.
Declaration
Objective-C
- (NSString *)lookupKeyForAsset:(NSString *)asset fromPackage:(NSString *)package;
Parameters
asset
The name of the asset. The name can be hierarchical.
package
The name of the package from which the asset originates.
Return Value
The file name to be used for lookup in the main bundle.
-
Sets the first route that the Flutter app shows. The default is
/
. This method will guarnatee that the initial route is delivered, even if the Flutter window hasn’t been created yet when called. It cannot be used to update the current route being shown in a visible FlutterViewController (see pushRoute and popRoute).Declaration
Objective-C
- (void)setInitialRoute:(NSString *)route;
Parameters
route
The name of the first route to show.
-
Instructs the Flutter Navigator (if any) to go back.
Declaration
Objective-C
- (void)popRoute;
-
Instructs the Flutter Navigator (if any) to push a route on to the navigation stack. The setInitialRoute method should be prefered if this is called before the FlutterViewController has come into view.
Declaration
Objective-C
- (void)pushRoute:(NSString *)route;
Parameters
route
The name of the route to push to the navigation stack.
-
The
FlutterPluginRegistry
used by this FlutterViewController.Declaration
Objective-C
- (id<FlutterPluginRegistry>)pluginRegistry;
-
Specifies the view to use as a splash screen. Flutter’s rendering is asynchronous, so the first frame rendered by the Flutter application might not immediately appear when theFlutter view is initially placed in the view hierarchy. The splash screen view will be used as a replacement until the first frame is rendered.
The view used should be appropriate for multiple sizes; an autoresizing mask to have a flexible width and height will be applied automatically.
Declaration
Objective-C
@property (readwrite, strong, nonatomic) UIView *splashScreenView;
-
Attempts to set the
splashScreenView
property from theUILaunchStoryboardName
from the main bundle’sInfo.plist
file. This method will not change the value ofsplashScreenView
if it cannot find a default one from a storyboard or nib.Declaration
Objective-C
- (BOOL)loadDefaultSplashScreenView;
Return Value
YES
if successful,NO
otherwise. -
Controls whether the created view will be opaque or not.
Default is
YES
. Note that setting this toNO
may negatively impact performance when using hardware acceleration, and toggling this will trigger a re-layout of the view.Declaration
Objective-C
@property (getter=isViewOpaque, assign, readwrite, nonatomic) BOOL viewOpaque;
-
The
FlutterEngine
instance for this view controller.Declaration
Objective-C
@property (readonly, nonatomic) FlutterEngine *engine;