---
title: "overlayView(_:shouldHandleKeyDownEvent:)"
framework: visionkit
role: symbol
role_heading: Instance Method
path: "visionkit/imageanalysisoverlayviewdelegate/overlayview(_:shouldhandlekeydownevent:)"
---

# overlayView(_:shouldHandleKeyDownEvent:)

Returns a Boolean value that indicates whether the overlay view consumes the given key-down event.

## Declaration

```swift
@MainActor func overlayView(_ overlayView: ImageAnalysisOverlayView, shouldHandleKeyDownEvent event: NSEvent) -> Bool
```

## Parameters

- `overlayView`: The overlay view that receives the key-down event.
- `event`: The key-down event that occurs.

## Return Value

Return Value true if the overlay view handles the event; otherwise, false.

## Discussion

Discussion The default return value is true. Implement this callback if you don’t want the overlay view to consume the given event.

## See Also

### Responding to key and menu events

- [overlayView(_:shouldShowMenuForEvent:atPoint:)](visionkit/imageanalysisoverlayviewdelegate/overlayview(_:shouldshowmenuforevent:atpoint:).md)
- [overlayView(_:menu:willHighlight:)](visionkit/imageanalysisoverlayviewdelegate/overlayview(_:menu:willhighlight:).md)
- [overlayView(_:willOpen:)](visionkit/imageanalysisoverlayviewdelegate/overlayview(_:willopen:).md)
- [overlayView(_:didClose:)](visionkit/imageanalysisoverlayviewdelegate/overlayview(_:didclose:).md)
- [overlayView(_:needsUpdate:)](visionkit/imageanalysisoverlayviewdelegate/overlayview(_:needsupdate:).md)
- [overlayView(_:updatedMenuFor:for:at:)](visionkit/imageanalysisoverlayviewdelegate/overlayview(_:updatedmenufor:for:at:).md)