FlutterCursorCoordinator Class Reference

#include <FlutterMutatorView.h>

Inheritance diagram for FlutterCursorCoordinator:

Instance Methods
(nonnull FlutterCursorCoordinator *)	- initWithFlutterView:
(FlutterCursorCoordinator *)	- initWithFlutterView: [implementation]
(void)	- frameCleanup [implementation]
(BOOL)	- cleanupScheduled [implementation]
(void)	- processMouseMoveEvent:forMutatorView:overlayRegion: [implementation]

Detailed Description

FlutterCursorCoordinator is responsible for coordinating cursor changes between platform views and overlays of single FlutterView.

Definition at line 45 of file FlutterMutatorView.h.

Method Documentation

cleanupScheduled

- (BOOL) cleanupScheduled

implementation

Provided by category FlutterCursorCoordinator(Private).

Definition at line 36 of file FlutterMutatorView.mm.

                         {
  return _cleanupScheduled;
}

frameCleanup

- (void) frameCleanup

implementation

Definition at line 36 of file FlutterMutatorView.mm.

                     {
  _cleanupScheduled = NO;
  _mouseMoveHandled = NO;
}

initWithFlutterView: [1/2]

- (FlutterCursorCoordinator *) initWithFlutterView: (FlutterView*)  flutterView

implementation

Definition at line 36 of file FlutterMutatorView.mm.

                                                :(FlutterView*)flutterView {
  if (self = [super init]) {
    _flutterView = flutterView;
  }
  return self;
}

initWithFlutterView: [2/2]

- (nonnull FlutterCursorCoordinator *) initWithFlutterView:

(nonnull FlutterView *)

flutterView

processMouseMoveEvent:forMutatorView:overlayRegion:

- (void) processMouseMoveEvent: (NSEvent*)  event forMutatorView: (FlutterMutatorView*)  view overlayRegion: (const std::vector<CGRect>&)  region

implementation

Provided by category FlutterCursorCoordinator(Private).

Definition at line 36 of file FlutterMutatorView.mm.

                             :(NSEvent*)event
               forMutatorView:(FlutterMutatorView*)view
                overlayRegion:(const std::vector<CGRect>&)region {
  // [self frameCleanup] will be called once after current run loop turn.
  if (!_cleanupScheduled) {
    [[NSRunLoop mainRunLoop] performBlock:^{
      [self frameCleanup];
    }];
    _cleanupScheduled = YES;
  }
 
  // Mouse move was already handled by a mutator view above.
  if (_mouseMoveHandled) {
    return;
  }
 
  NSPoint point = [view convertPoint:event.locationInWindow fromView:nil];
 
  // If the mouse is above overlay region restore current Flutter cursor.
  for (const auto& r : region) {
    if (CGRectContainsPoint(r, point)) {
      [_flutterView cursorUpdate:event];
      _mouseMoveHandled = YES;
      return;
    }
  }
  NSView* platformView = view.platformView;
  // It is possible that Flutter changed mouse cursor while the mouse was inside
  // cursor rect. Unfocused NSTextField uses legacy cursor rects for changing
  // its cursor.
  [platformView.window invalidateCursorRectsForView:platformView];
  _mouseMoveHandled = YES;
}

---

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

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