FlutterMouseCursorPlugin Class Reference

#import <FlutterMouseCursorPlugin.h>

Inheritance diagram for FlutterMouseCursorPlugin:

Instance Methods
(instancetype)	- init [implementation]
(FlutterError *)	- activateSystemCursor: [implementation]
(void)	- displayCursorObject: [implementation]
(void)	- handleMethodCall:result: [implementation]
Instance Methods inherited from <FlutterPlugin>
(void)	- handleMethodCall:result:
(void)	- detachFromEngineForRegistrar:
(void)	- handleMethodCall:result:
Instance Methods inherited from <FlutterApplicationLifeCycleDelegate>
(BOOL)	- application:didFinishLaunchingWithOptions:
(BOOL)	- application:willFinishLaunchingWithOptions:
(void)	- applicationDidBecomeActive:
(void)	- applicationWillResignActive:
(void)	- applicationDidEnterBackground:
(void)	- applicationWillEnterForeground:
(void)	- applicationWillTerminate:
(void)	- application:didRegisterUserNotificationSettings:
(void)	- application:didRegisterForRemoteNotificationsWithDeviceToken:
(void)	- application:didFailToRegisterForRemoteNotificationsWithError:
(BOOL)	- application:didReceiveRemoteNotification:fetchCompletionHandler:
(void)	- application:didReceiveLocalNotification:
(BOOL)	- application:openURL:options:
(BOOL)	- application:handleOpenURL:
(BOOL)	- application:openURL:sourceApplication:annotation:
(BOOL)	- application:performActionForShortcutItem:completionHandler:
(BOOL)	- application:handleEventsForBackgroundURLSession:completionHandler:
(BOOL)	- application:performFetchWithCompletionHandler:
(BOOL)	- application:continueUserActivity:restorationHandler:
Instance Methods inherited from <FlutterAppLifecycleDelegate>
(void)	- handleWillFinishLaunching:
(void)	- handleDidFinishLaunching:
(void)	- handleWillBecomeActive:
(void)	- handleDidBecomeActive:
(void)	- handleWillResignActive:
(void)	- handleDidResignActive:
(void)	- handleWillHide:
(void)	- handleDidHide:
(void)	- handleWillUnhide:
(void)	- handleDidUnhide:
(void)	- handleDidChangeScreenParameters:
(void)	- handleDidChangeOcclusionState:
(BOOL)	- handleOpenURLs:
(void)	- handleWillTerminate:

Class Methods
(void)	+ registerWithRegistrar:delegate:
(NSCursor *)	+ cursorFromKind: [implementation]
(void)	+ registerWithRegistrar: [implementation]
(void)	+ registerWithRegistrar:delegate: [implementation]
Class Methods inherited from <FlutterPlugin>
(void)	+ registerWithRegistrar:
(void)	+ setPluginRegistrantCallback:
(void)	+ registerWithRegistrar:

Properties
id< FlutterMouseCursorPluginDelegate >	delegate [implementation]

Detailed Description

A plugin to handle mouse cursor.

Responsible for bridging the native macOS mouse cursor system with the Flutter framework mouse cursor classes, via system channels.

Definition at line 23 of file FlutterMouseCursorPlugin.h.

Method Documentation

activateSystemCursor:

- (FlutterError *) activateSystemCursor: (nonnull NSDictionary *)  arguments

implementation

Handles the method call that activates a system cursor.

Returns a FlutterError if the arguments can not be recognized. Otherwise returns nil.

Definition at line 96 of file FlutterMouseCursorPlugin.mm.

                                     :(nonnull NSDictionary*)arguments {
  NSString* kindArg = arguments[kKindKey];
  if (!kindArg) {
    return [FlutterError errorWithCode:@"error"
                               message:@"Missing argument"
                               details:@"Missing argument while trying to activate system cursor"];
  }
 
  NSCursor* cursorObject = [FlutterMouseCursorPlugin cursorFromKind:kindArg];
  [self displayCursorObject:cursorObject];
  return nil;
}

cursorFromKind:

+ (NSCursor *) cursorFromKind: (NSString*)  kind

implementation

Definition at line 96 of file FlutterMouseCursorPlugin.mm.

                           :(NSString*)kind {
  NSCursor* cachedValue = [cachedSystemCursors objectForKey:kind];
  if (!cachedValue) {
    cachedValue = GetCursorForKind(kind);
    [cachedSystemCursors setValue:cachedValue forKey:kind];
  }
  return cachedValue;
}

displayCursorObject:

- (void) displayCursorObject: (nonnull NSCursor *)  cursorObject

implementation

Displays the specified cursor.

Unhides the cursor before displaying the cursor, and updates internal states.

Definition at line 96 of file FlutterMouseCursorPlugin.mm.

                           :(nonnull NSCursor*)cursorObject {
  [cursorObject set];
  [self.delegate didUpdateMouseCursor:cursorObject];
}

handleMethodCall:result:

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

implementation

Handles all method calls from Flutter.

Reimplemented from <FlutterPlugin>.

Definition at line 96 of file FlutterMouseCursorPlugin.mm.

                        :(FlutterMethodCall*)call result:(FlutterResult)result {
  NSString* method = call.method;
  if ([method isEqualToString:kActivateSystemCursorMethod]) {
    result([self activateSystemCursor:call.arguments]);
  } else {
    result(FlutterMethodNotImplemented);
  }
}

init

- (instancetype) init

implementation

Definition at line 96 of file FlutterMouseCursorPlugin.mm.

                     {
  self = [super init];
  if (self) {
    cachedSystemCursors = [NSMutableDictionary dictionary];
  }
  return self;
}

registerWithRegistrar:

+ (void) registerWithRegistrar: (id< FlutterPluginRegistrar >)  registrar

implementation

Creates an instance of the plugin to register with |registrar| using the desired FlutterPluginRegistrar methods.

Reimplemented from <FlutterPlugin>.

Definition at line 96 of file FlutterMouseCursorPlugin.mm.

                             :(id<FlutterPluginRegistrar>)registrar {
  [self registerWithRegistrar:registrar delegate:nil];
}

registerWithRegistrar:delegate: [1/2]

+ (void) registerWithRegistrar: (id<FlutterPluginRegistrar>)  registrar delegate: (id<FlutterMouseCursorPluginDelegate>)  delegate

implementation

Definition at line 96 of file FlutterMouseCursorPlugin.mm.

                             :(id<FlutterPluginRegistrar>)registrar
                     delegate:(id<FlutterMouseCursorPluginDelegate>)delegate {
  FlutterMethodChannel* channel = [FlutterMethodChannel methodChannelWithName:kMouseCursorChannel
                                                              binaryMessenger:registrar.messenger];
  FlutterMouseCursorPlugin* instance = [[FlutterMouseCursorPlugin alloc] init];
  instance.delegate = delegate;
  [registrar addMethodCallDelegate:instance channel:channel];
}

registerWithRegistrar:delegate: [2/2]

+ (void) registerWithRegistrar:		(nonnull id< FlutterPluginRegistrar >)	registrar
delegate:		(nullable id< FlutterMouseCursorPluginDelegate >)	delegate

Property Documentation

delegate

- (id<FlutterMouseCursorPluginDelegate>) delegate

readwritenonatomicweakimplementation

Definition at line 67 of file FlutterMouseCursorPlugin.mm.

---

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

• shell/platform/darwin/macos/framework/Source/FlutterMouseCursorPlugin.h
• shell/platform/darwin/macos/framework/Source/FlutterMouseCursorPlugin.mm