<!--
{
  "availability" : [
    "macOS: -"
  ],
  "documentType" : "symbol",
  "framework" : "AppKit",
  "identifier" : "/documentation/AppKit/NSResponder/shouldBeTreatedAsInkEvent(_:)",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "AppKit"
    ],
    "preciseIdentifier" : "c:objc(cs)NSResponder(im)shouldBeTreatedAsInkEvent:"
  },
  "title" : "shouldBeTreatedAsInkEvent(_:)"
}
-->

# shouldBeTreatedAsInkEvent(_:)

Indicates whether a pen-down event should be treated as an ink event.

```
func shouldBeTreatedAsInkEvent(_ event: NSEvent) -> Bool
```

## Parameters

`event`

An event object representing the event to be tested.

## Return Value

Returns <doc://com.apple.documentation/documentation/Swift/true> if the specified event should be treated as an ink event, <doc://com.apple.documentation/documentation/Swift/false> if it should be treated as a mouse event.

## Discussion

This method provides the ability to distinguish when a pen-down event should start inking versus when a pen-down event should be treated as a mouse-down event. This allows for a write-anywhere model for pen-based input.

The default implementation in [`NSApplication`](/documentation/AppKit/NSApplication) sends the method to the [`NSWindow`](/documentation/AppKit/NSWindow) object under the pen. If the window is inactive, this method returns <doc://com.apple.documentation/documentation/Swift/true>, unless the pen-down is in the window drag region. If the window is active, this method is sent to the [`NSView`](/documentation/AppKit/NSView) object under the pen.

The default implementation in [`NSView`](/documentation/AppKit/NSView) returns <doc://com.apple.documentation/documentation/Swift/true>, and [`NSControl`](/documentation/AppKit/NSControl) overrides and returns <doc://com.apple.documentation/documentation/Swift/false>. This allows write-anywhere over most `NSView` objects, but allows the pen to be used to track in controls and to move windows.

A custom view should override this method to get the correct behavior for a pen-down in the view.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)