Review Changes

Author: gspencergoog

shell/platform/darwin/macos/framework/Headers/FlutterViewController.h

@@ -39,19 +39,6 @@ FLUTTER_EXPORT
  */
 @property(nonatomic) FlutterMouseTrackingMode mouseTrackingMode;
 
-/**
- * Initializes this FlutterViewController with the specified `FlutterEngine`.
- *
- * The initialized viewcontroller will attach itself to the engine as part of this process.
- *
- * @param engine The `FlutterEngine` instance to attach to. Cannot be nil.
- * @param nibName The NIB name to initialize this controller with.
- * @param nibBundle The NIB bundle.
- */
-- (nonnull instancetype)initWithEngine:(nonnull FlutterEngine*)engine
-                               nibName:(nullable NSString*)nibName
-                                bundle:(nullable NSBundle*)nibBundle NS_DESIGNATED_INITIALIZER;
-
 /**
  * Initializes a controller that will run the given project.
  *

shell/platform/darwin/macos/framework/Source/FlutterIntermediateKeyResponder.h

@@ -5,14 +5,12 @@
 #import <Cocoa/Cocoa.h>
 
 /*
- * An interface for adding key responders that are processed after the framework
- * has had a chance to handle the key, but before the next responder is given
- * the key.
+ * An interface for adding key responders that can declare itself as the final
+ * responder of the event, terminating the event propagation.
  *
- * It differs from an NSResponder in that it returns a boolean from the keyUp
- * and keyDown calls, allowing the callee to indicate whether or not it handled
- * the given event. If handled, then the event is not passed to the next
- * responder.
+ * It differs from an NSResponder in that it returns a boolean from the
+ * handleKeyUp and handleKeyDown calls, where true means it has handled the
+ * given event. A handled event is not passed to the next responder.
  */
 @interface FlutterIntermediateKeyResponder : NSObject
 /*

shell/platform/darwin/macos/framework/Source/FlutterViewController.mm

@@ -82,7 +82,12 @@ void Reset() {
 @interface FlutterViewController () <FlutterViewReshapeListener>
 
 /**
- * A list of additional responders to keyboard events. Keybord events are forwarded to all of them.
+ * A list of additional responders to keyboard events.
+ *
+ * Keyboard events received by FlutterViewController are first dispatched to
+ * each additional responder in order. If any of them handle the event (by
+ * returning true), the event is not dispatched to later additional responders
+ * or to the nextResponder.
  */
 @property(nonatomic) NSMutableOrderedSet<FlutterIntermediateKeyResponder*>* additionalKeyResponders;
 
@@ -135,7 +140,8 @@ - (void)dispatchMouseEvent:(nonnull NSEvent*)event;
 - (void)dispatchMouseEvent:(nonnull NSEvent*)event phase:(FlutterPointerPhase)phase;
 
 /**
- * Sends |event| to all responders in additionalKeyResponders and then to the nextResponder.
+ * Sends |event| to all responders in additionalKeyResponders and then to the
+ * nextResponder if none of the additional responders handled the event.
  */
 - (void)propagateKeyEvent:(NSEvent*)event ofType:(NSString*)type;
 
@@ -494,21 +500,17 @@ - (void)dispatchMouseEvent:(NSEvent*)event phase:(FlutterPointerPhase)phase {
 - (void)propagateKeyEvent:(NSEvent*)event ofType:(NSString*)type {
   if ([type isEqual:@"keydown"]) {
     for (FlutterIntermediateKeyResponder* responder in self.additionalKeyResponders) {
-      if ([responder respondsToSelector:@selector(handleKeyDown:)]) {
-        if ([responder handleKeyDown:event]) {
-          return;
-        }
+      if ([responder handleKeyDown:event]) {
+        return;
       }
     }
     if ([self.nextResponder respondsToSelector:@selector(keyDown:)]) {
       [self.nextResponder keyDown:event];
     }
   } else if ([type isEqual:@"keyup"]) {
     for (FlutterIntermediateKeyResponder* responder in self.additionalKeyResponders) {
-      if ([responder respondsToSelector:@selector(handleKeyUp:)]) {
-        if ([responder handleKeyUp:event]) {
-          return;
-        }
+      if ([responder handleKeyUp:event]) {
+        return;
       }
     }
     if ([self.nextResponder respondsToSelector:@selector(keyUp:)]) {

shell/platform/darwin/macos/framework/Source/FlutterViewController_Internal.h

@@ -28,4 +28,16 @@
  */
 - (void)removeKeyResponder:(nonnull FlutterIntermediateKeyResponder*)responder;
 
+/**
+ * Initializes this FlutterViewController with the specified `FlutterEngine`.
+ *
+ * The initialized viewcontroller will attach itself to the engine as part of this process.
+ *
+ * @param engine The `FlutterEngine` instance to attach to. Cannot be nil.
+ * @param nibName The NIB name to initialize this controller with.
+ * @param nibBundle The NIB bundle.
+ */
+- (nonnull instancetype)initWithEngine:(nonnull FlutterEngine*)engine
+                               nibName:(nullable NSString*)nibName
+                                bundle:(nullable NSBundle*)nibBundle NS_DESIGNATED_INITIALIZER;
 @end