| Inherits from | |
| Conforms to | |
| Framework | /System/Library/Frameworks/AppKit.framework |
| Availability | Available in Mac OS X v10.0 and later. |
| Companion guide | |
| Declared in | NSEvent.h NSTouch.h |
An NSEvent object, or simply an event, contains information about an input action such as a mouse click or a key down. The Application Kit associates each such user action with a window, reporting the event to the application that created the window. The NSEvent object contains pertinent information about each event, such as where the cursor was located or which character was typed. As the application receives events, it temporarily places them in a buffer called the event queue. When the application is ready to process an event, it takes one from the queue.
Beginning with Mac OS X version 10.4, NSEvent objects can represent tablet-pointing and tablet-proximity events. A tablet-proximity event is generated when a pointing device enters or leaves proximity of its tablet; such event objects have a type of NSTypeProximity or a mouse subtype of NSTabletProximityEventSubtype. A tablet-pointing event is generated when a pointing device changes state, such as location, pressure, or tilt; such event objects have a type of NSTypePoint or a mouse subtype of NSTabletPointEventSubtype. The Application Kit reports all pure tablet events to responder objects through the NSResponder methods tabletPoint: and tabletProximity:. Mouse events can also contain tablet data (as event subtypes), so you can handle these events by overriding the NSResponder methods mouseDown:, mouseDragged:, and mouseUp:.
Support for touch and gesture events masks have been added to NSEvent in Mac OS X v10.6. Magnify (pinch), swipe, and rotate masks are supported, as are more generic gesture masks. Using touchesMatchingPhase:inView: method a view can get all of the touch events associated with a gesture without overriding the individual touch responder methods defined in NSResponder.
Mac OS X v10.6 adds the ability to create application event monitors that call block object handlers for certain event types that are sent through the NSApplication sendEvent: method. You can create a local monitor that will be informed of the events in your application and allow you to modify or cancel them. You can also create a global event monitor that allows you to monitor events in other applications, although you are unable to alter those events. See “Monitoring Application Events” for more information.
+ keyEventWithType:location:modifierFlags:timestamp:windowNumber:context:characters:charactersIgnoringModifiers:isARepeat:keyCode:
+ mouseEventWithType:location:modifierFlags:timestamp:windowNumber:context:eventNumber:clickCount:pressure:
+ enterExitEventWithType:location:modifierFlags:timestamp:windowNumber:context:eventNumber:trackingNumber:userData:
+ otherEventWithType:location:modifierFlags:timestamp:windowNumber:context:subtype:data1:data2:
+ eventWithEventRef:
+ eventWithCGEvent:
– context
– locationInWindow
– modifierFlags
– timestamp
– type
– window
– windowNumber
– eventRef
– CGEvent
+ modifierFlags
+ keyRepeatDelay
+ keyRepeatInterval
– characters
– charactersIgnoringModifiers
– isARepeat
– keyCode
+ pressedMouseButtons
+ doubleClickInterval
+ mouseLocation
– buttonNumber
– clickCount
– pressure
+ setMouseCoalescingEnabled:
+ isMouseCoalescingEnabled
– capabilityMask
– deviceID
– isEnteringProximity
– pointingDeviceID
– pointingDeviceSerialNumber
– pointingDeviceType
– systemTabletID
– tabletID
– uniqueID
– vendorID
– vendorPointingDeviceType
– absoluteX
– absoluteY
– absoluteZ
– buttonMask
– rotation
– tangentialPressure
– tilt
– vendorDefined
Installs an event monitor that receives copies of events posted to other applications.
+ (id)addGlobalMonitorForEventsMatchingMask:(NSEventMask)mask handler:(void (^)(NSEvent*))block
An event mask specifying which events you wish to monitor. See Masks for event types for possible values.
The event handler block object. It is passed the event to monitor. You are unable to change the event, merely observe it.
An event handler object.
Events are delivered asynchronously to your app and you can only observe the event; you cannot modify or otherwise prevent the event from being delivered to its original target application.
Key-related events may only be monitored if accessibility is enabled or if your application is trusted for accessibility access (see AXIsProcessTrusted).
Note that your handler will not be called for events that are sent to your own application.
In Mac OS X v 10.6, event monitors are only able to monitor the following event types:
NSEvent.hInstalls an event monitor that receives copies of events posted to this application before they are dispatched.
+ (id)addLocalMonitorForEventsMatchingMask:(NSEventMask)mask handler:(NSEvent* (^)(NSEvent*))block
An event mask specifying which events you wish to monitor. See Masks for event types for possible values.
The event handler block object. It is passed the event to monitor. You can return the event unmodified, create and return a new NSEvent object, or return nil to stop the dispatching of the event.
An event handler object.
Your handler will not be called for events that are consumed by nested event-tracking loops such as control tracking, menu tracking, or window dragging; only events that are dispatched through the applications sendEvent: method will be passed to your handler.
In Mac OS X v 10.6, event monitors are only able to monitor the following event types:
NSEvent.hReturns the time, in seconds, in which a second mouse click must occur in order to be considered a double click.
+ (NSTimeInterval)doubleClickInterval
The double-click time interval, in seconds.
This is a system setting, overriding this method will have no effect.
NSEvent.hReturns a new NSEvent object describing a tracking-rectangle or cursor-update event.
+ (NSEvent *)enterExitEventWithType:(NSEventType)type location:(NSPoint)location modifierFlags:(NSUInteger)flags timestamp:(NSTimeInterval)time windowNumber:(NSInteger)windowNumber context:(NSGraphicsContext *)context eventNumber:(NSInteger)eventNumber trackingNumber:(NSInteger)trackingNumber userData:(void *)userData
One of the following event-type constants: NSMouseEntered, NSMouseExited, NSCursorUpdate. If the specified constant is not one of these, an NSInternalInconsistencyException is raised
The cursor location in the base coordinate system of the window specified by windowNum.
An integer bit field containing any of the modifier key masks described in “Constants,” combined using the C bitwise OR operator.
The time the event occurred in seconds since system startup.
An integer that identifies the window device associated with the event, which is associated with the NSWindow that will receive the event.
The display graphics context of the event.
An identifier for the new event. It’s normally taken from a counter for mouse events, which continually increases as the application runs.
A number that identifies the tracking rectangle. This identifier is the same as that returned by the NSView method addTrackingRect:owner:userData:assumeInside:.
Data arbitrarily associated with the tracking rectangle when it was set up using the NSView method addTrackingRect:owner:userData:assumeInside:.
The created NSEvent object or nil if the object could not be created.
NSEvent.hCreates and returns an event object that is based on a Core Graphics type of event.
+ (NSEvent *)eventWithCGEvent:(CGEventRef)cgEvent
A CGEventRef opaque type that represents an event.
An autoreleased NSEvent object that is equivalent to cgEvent.
The returned object retains the CGEventRef object (cgEvent) until it (the Objective-C object) is freed—it then releases the CGEventRef object. If no Cocoa event corresponds to the CGEventRef object, this method returns nil.
NSEvent.hCreates an event object that is based on a Carbon type of event.
+ (NSEvent *)eventWithEventRef:(const void *)eventRef
The EventRef opaque type to be associated with the created NSEvent object.
An autoreleased NSEvent object corresponding to eventRef or nil if eventRef cannot be converted into an equivalent NSEvent object.
This method is valid for all events. The created NSEvent object retains the EventRef object and is released when the NSEvent object is freed.
NSEvent.hIndicates whether mouse-movement event coalescing is enabled.
+ (BOOL)isMouseCoalescingEnabled
YES if mouse-movement event coalescing is enabled, NO if it is disabled.
NSEvent.hReturns a new NSEvent object describing a key event.
+ (NSEvent *)keyEventWithType:(NSEventType)type location:(NSPoint)location modifierFlags:(NSUInteger)flags timestamp:(NSTimeInterval)time windowNumber:(NSInteger)windowNum context:(NSGraphicsContext *)context characters:(NSString *)characters charactersIgnoringModifiers:(NSString *)unmodCharacters isARepeat:(BOOL)repeatKey keyCode:(unsigned short)code
One of the following event-type constants: NSKeyDown, NSKeyUp, NSFlagsChanged. If anything else is specified, an NSInternalInconsistencyException is raised.
The cursor location in the base coordinate system of the window specified by windowNum.
An integer bit field containing any of the modifier key masks described in “Constants,” combined using the C bitwise OR operator.
The time the event occurred in seconds since system startup.
An integer that identifies the window device associated with the event, which is associated with the NSWindow that will receive the event.
The display graphics context of the event.
A string of characters associated with the key event. Though most key events contain only one character, it is possible for a single keypress to generate a series of characters.
The string of characters generated by the key event as if no modifier key had been pressed (except for Shift). This argument is useful for getting the “basic” key value in a hardware-independent manner.
YES if the key event is a repeat caused by the user holding the key down, NO if the key event is new.
A number that identifies the keyboard key associated with the key event. Its value is hardware-independent.
The created NSEvent instance or nil if the instance could not be created.
NSEvent.hReturns the length of time a key must be held down in order to generate the first key repeat event.
+ (NSTimeInterval)keyRepeatDelay
The delay interval, in seconds.
This is a system setting, overriding this method will have no effect.
NSEvent.hReturns the length between subsequent key repeat events being posted.
+ (NSTimeInterval)keyRepeatInterval
The repeat interval, in seconds.
This is a system setting, overriding this method will have no effect.
NSEvent.hReturns the currently pressed modifier flags.
+ (NSUInteger)modifierFlags
A mask of the current modifiers using the values in “Modifier Flags.”
This returns the state of devices combined with synthesized events at the moment, independent of which events have been delivered via the event stream.
NSEvent.hReturns a new NSEvent object describing a mouse-down, -up, -moved, or -dragged event.
+ (NSEvent *)mouseEventWithType:(NSEventType)type location:(NSPoint)location modifierFlags:(NSUInteger)flags timestamp:(NSTimeInterval)time windowNumber:(NSInteger)windowNum context:(NSGraphicsContext *)context eventNumber:(NSInteger)eventNumber clickCount:(NSInteger)clickNumber pressure:(float)pressure
One of the modifier key masks described in “Constants,” or an NSInternalInconsistencyException is raised.
The cursor location in the base coordinate system of the window specified by windowNum.
An integer bit field containing any of the modifier key masks described in “Constants,” combined using the C bitwise OR operator.
The time the event occurred in seconds since system startup.
An integer that identifies the window device associated with the event, which is associated with the NSWindow that will receive the event.
The display graphics context of the event.
An identifier for the new event. It’s normally taken from a counter for mouse events, which continually increases as the application runs.
The number of mouse clicks associated with the mouse event.
A value from 0.0 to 1.0 indicating the pressure applied to the input device on a mouse event, used for an appropriate device such as a graphics tablet. For devices that aren’t pressure-sensitive, the value should be either 0.0 or 1.0.
The created NSEvent instance or nil if the instance could not be created.
NSEvent.hReports the current mouse position in screen coordinates.
+ (NSPoint)mouseLocation
The current mouse location in screen coordinates.
This method is similar to the NSWindow method mouseLocationOutsideOfEventStream. It returns the location regardless of the current event or pending events. The difference between these methods is that mouseLocationOutsideOfEventStream returns a point in the receiving window’s coordinates and mouseLocation returns the same information in screen coordinates.
NSEvent.hReturns a new NSEvent object describing a custom event.
+ (NSEvent *)otherEventWithType:(NSEventType)type location:(NSPoint)location modifierFlags:(NSUInteger)flags timestamp:(NSTimeInterval)time windowNumber:(NSInteger)windowNum context:(NSGraphicsContext *)context subtype:(short)subtype data1:(NSInteger)data1 data2:(NSInteger)data2
One of the following event-type constants:
If type is anything else, an NSInternalInconsistencyException is raised. Your code should only create events of type NSApplicationDefined.
The cursor location in the base coordinate system of the window specified by windowNum.
An integer bit field containing any of the modifier key masks described in “Constants,” combined using the C bitwise OR operator.
The time the event occurred in seconds since system startup.
An integer that identifies the window device associated with the event, which is associated with the NSWindow that will receive the event.
The display graphics context of the event.
A numeric identifier that further differentiates custom events of types NSAppKitDefined, NSSystemDefined, and NSApplicationDefined. NSPeriodic events don’t use this attribute.
Additional data associated with the event. NSPeriodic events don’t use these attributes.
Additional data associated with the event. NSPeriodic events don’t use these attributes.
The created NSEvent object or nil if the object couldn't be created.
NSEvent.hReturns the indices of the currently depressed mouse buttons.
+ (NSUInteger)pressedMouseButtons
The indices of the currently depressed mouse buttons.
A return value of 1 << 0 corresponds to left the mouse, 1 << 1 corresponds to the right mouse, 1<< n, n >=2 to other mouse buttons.
This returns the state of devices combined with synthesized events at the moment, independent of which events have been delivered via the event stream, so this method is not suitable for tracking.
NSEvent.hRemove the specified event monitor.
+ (void)removeMonitor:(id)eventMonitor
The event handler object to remove.
You must ensure that eventMonitor is removed only once. Removing the same eventMonitor instance multiple times results in an over-release condition, even in a Garbage Collected environment
NSEvent.hControls whether mouse-movement event coalescing is enabled.
+ (void)setMouseCoalescingEnabled:(BOOL)flag
YES to enable mouse-movement event coalescing, NO to disable it.
This method affects mouse-moved, mouse-dragged, and tablet events. Mouse-movement event coalescing is enabled by default.
NSEvent.hBegins generating periodic events for the current thread.
+ (void)startPeriodicEventsAfterDelay:(NSTimeInterval)delaySeconds withPeriod:(NSTimeInterval)periodSeconds
The number of seconds that NSEvent should wait before beginning to generate periodic events.
The period in seconds between the generated events.
Raises an NSInternalInconsistencyException if periodic events are already being generated for the current thread. This method is typically used in a modal loop while tracking mouse-dragged events.
NSEvent.hStops generating periodic events for the current thread and discards any periodic events remaining in the queue.
+ (void)stopPeriodicEvents
This message is ignored if periodic events aren’t currently being generated.
NSEvent.hReports the absolute x coordinate of a pointing device on its tablet at full tablet resolution.
- (NSInteger)absoluteX
For the coordinate to be valid, the receiver should represent an event generated by a tablet pointing device (otherwise 0 is returned). This method is valid only for mouse events with a subtype of NSTabletPointEventSubtype and for events of type NSTabletPoint. Use this value if you want to scale from tablet location to screen location yourself; otherwise use the class method mouseLocation or the instance method locationInWindow.
NSEvent.hReports the absolute y coordinate of a pointing device on its tablet at full tablet resolution.
- (NSInteger)absoluteY
For the coordinate to be valid, the receiver should represent an event generated by a tablet pointing device (otherwise 0 is returned). This method is valid only for mouse events with a subtype of NSTabletPointEventSubtype and for events of type NSTabletPoint. Use this value if you want to scale from tablet location to screen location yourself; otherwise use the class method mouseLocation or the instance method locationInWindow.
NSEvent.hReports the absolute z coordinate of pointing device on its tablet at full tablet resolution.
- (NSInteger)absoluteZ
For the coordinate to be valid, the receiver should represent an event generated by a tablet pointing device (otherwise 0 is returned). The z coordinate does not represent pressure. It registers the depth coordinate returned by some tablet devices with wheels; if the device is something other than these, 0 is returned. This method is valid only for mouse events with a subtype of NSTabletPointEventSubtype and for events of type NSTabletPoint.
NSEvent.hReturns a bit mask identifying the buttons pressed when the tablet event represented by the receiver was generated.
- (NSUInteger)buttonMask
Use one or more of the button-mask constants described in “Constants” to determine which buttons of the pointing device are pressed. This method is valid only for mouse events with a subtype of NSTabletPointEventSubtype and for events of type NSTabletPoint.
NSEvent.hReturns the button number for the mouse button that generated an NSOtherMouse... event.
- (NSInteger)buttonNumber
This method is intended for use with the NSOtherMouseDown, NSOtherMouseUp, and NSOtherMouseDragged events, but will return values for NSLeftMouse... and NSRightMouse... events also.
NSEvent.hReturns a mask whose set bits indicate the capabilities of the tablet device that generated the event represented by the receiver.
- (NSUInteger)capabilityMask
These bits are vendor-defined. This method is valid only for mouse events with a subtype of NSTabletProximityEventSubtype and for events of type NSTabletProximity.
NSEvent.hReturns a Core Graphics event object corresponding to the receiver.
- (CGEventRef)CGEvent
The returned CGEventRef opaque type is autoreleased. If no CGEventRef object corresponding to the NSEvent object can be created, this method returns NULL.
NSEvent.hReturns the characters associated with the receiving key-up or key-down event.
- (NSString *)characters
These characters are derived from a keyboard mapping that associates various key combinations with Unicode characters. Raises an NSInternalInconsistencyException if sent to any other kind of event object.
This method returns an empty string for dead keys, such as Option-e. However, for a key combination such as Option-Shift-e this method returns the standard accent ("´").
For a list of constants corresponding to commonly-used Unicode characters, see NSText Class Reference.
NSEvent.hReturns the characters generated by the receiving key event as if no modifier key (except for Shift) applies.
- (NSString *)charactersIgnoringModifiers
Raises an NSInternalInconsistencyException if sent to a nonkey event.
This method returns the non-modifier key character pressed for dead keys, such as Option-e. For example, Option-e (no shift key) returns an “e" for this method, whereas the characters method returns an empty string.
This method is useful for determining “basic” key values in a hardware-independent manner, enabling such features as keyboard equivalents defined in terms of modifier keys plus character keys. For example, to determine if the user typed Alt-S, you don’t have to know whether Alt-S generates a German double ess, an integral sign, or a section symbol. You simply examine the string returned by this method along with the event’s modifier flags, checking for “s” and NSAlternateKeyMask.
For a list of constants corresponding to commonly-used Unicode characters, see NSText Class Reference.
NSEvent.hReturns the number of mouse clicks associated with the receiver, which represents a mouse-down or mouse-up event.
- (NSInteger)clickCount
Raises an NSInternalInconsistencyException if sent to a nonmouse event.
Returns 0 for a mouse-up event if a time threshold has passed since the corresponding mouse-down event. This is because if this time threshold passes before the mouse button is released, it is no longer considered a mouse click, but a mouse-down event followed by a mouse-up event.
The return value of this method is meaningless for events other than mouse-down or mouse-up events.
NSEvent.hReturns the display graphics context of the receiver.
- (NSGraphicsContext *)context
NSEvent.hReturns additional data associated with the receiver.
- (NSInteger)data1
The value returned by this method is dependent on the event type, and is defined by the originator of the event. Raises an NSInternalInconsistencyException if sent to an event not of type NSAppKitDefined, NSSystemDefined, NSApplicationDefined, or NSPeriodic.
NSPeriodic events don’t use this attribute.
NSEvent.hReturns additional data associated with the receiver.
- (NSInteger)data2
The value returned by this method is dependent on the event type, and is defined by the originator of the event. Raises an NSInternalInconsistencyException if sent to an event not of type NSAppKitDefined, NSSystemDefined, NSApplicationDefined, or NSPeriodic.
NSPeriodic events don’t use this attribute.
NSEvent.hReturns the x-coordinate change for a scroll wheel, mouse-move, or mouse-drag event.
- (CGFloat)deltaX
NSEvent.hReturns the y-coordinate change for a scroll wheel, mouse-move, or mouse-drag event.
- (CGFloat)deltaY
The behavior of this method may seem counter-intuitive: as the mouse moves up the screen, the value is negative; and as it moves down the screen, the value is positive. The reason for this behavior is that NSEvent computes this delta value in device space, which is flipped, but both the screen and the window’s base coordinate system are not flipped.
NSEvent.hReturns the z-coordinate change for a scroll wheel, mouse-move, or mouse-drag event.
- (CGFloat)deltaZ
This value is typically 0.0.
NSEvent.hReturns a special identifier that is used to match tablet-pointer events with the tablet-proximity event represented by the receiver.
- (NSUInteger)deviceID
All tablet-pointer events generated in the period between the device entering and leaving tablet proximity have the same device ID. This message is valid only for mouse events with subtype NSTabletPointEventSubtype or NSTabletProximityEventSubtype, and for NSTabletPoint and NSTabletProximity events.
NSEvent.hReturns the counter value of the latest mouse or tracking-rectangle event object; every system-generated mouse and tracking-rectangle event increments this counter.
- (NSInteger)eventNumber
Raises an NSInternalInconsistencyException if sent to any other type of event object.
NSEvent.hReturns the Carbon type associated with the receiver for representing an event.
- (const void *)eventRef
Returns an EventRef opaque type corresponding to the receiver. User-input events typically are created with an associated EventRef. An NSEvent object created through other means creates an EventRef in this method if that is necessary and possible. If there is no equivalent NSEvent for the receiver, this method returns NULL.
This method is valid for all types of events. The EventRef object is retained by the receiver, so it is valid as long as the NSEvent object is valid, and is released when the NSEvent object is freed. You can use RetainEvent to extend the lifetime of the EventRef object, with a corresponding ReleaseEvent when you are done with it.
NSEvent.hReturns YES if the receiving key event is a repeat caused by the user holding the key down, NO if the key event is new.
- (BOOL)isARepeat
Raises an NSInternalInconsistencyException if sent to an NSFlagsChanged event or other nonkey event.
NSEvent.hReturns YES to indicate that a pointing device is entering the proximity of its tablet and NO when it is leaving it.
- (BOOL)isEnteringProximity
This method is valid for mouse events with subtype NSTabletProximityEventSubtype and for NSTabletProximity events.
NSEvent.hReturns the virtual key code for the keyboard key associated with the receiving key event.
- (unsigned short)keyCode
The virtual key code. The returned value is hardware-independent. The value returned is the same as the value returned in the kEventParamKeyCode when using Carbon Events.
Raises an NSInternalInconsistencyException if sent to a non-key event.
NSEvent.hReturns the receiver’s location in the base coordinate system of the associated window.
- (NSPoint)locationInWindow
For non-mouse events the return value of this method is undefined.
With NSMouseMoved and possibly other events, the receiver can have a nil window (that is, window returns nil). In this case, locationInWindow returns the event location in screen coordinates.
In a method of a custom view that handles mouse events, you commonly use the locationInWindow method in conjunction with the NSView method convertPoint:fromView:to get the mouse location in the view’s coordinate system. For example:
NSPoint event_location = [theEvent locationInWindow]; |
NSPoint local_point = [self convertPoint:event_location fromView:nil]; |
NSEvent.hReturns the change in magnification.
- (CGFloat)magnification
The change in magnification that should be added to the current scaling of an item to achieve the new scale factor.
This message is valid for events of type NSEventTypeMagnify.
NSEvent.hReturns an integer bit field indicating the modifier keys in effect for the receiver.
- (NSUInteger)modifierFlags
You can examine individual flag settings using the C bitwise AND operator with the predefined key masks described in “Constants.” The lower 16 bits of the modifier flags are reserved for device-dependent bits.
NSEvent.hReturns the index of the pointing device currently in proximity with the tablet.
- (NSUInteger)pointingDeviceID
This index is significant for multimode (or Dual Tracking) tablets that support multiple concurrent pointing devices; the index is incremented for each pointing device that comes into proximity. Otherwise, zero is always returned. The receiver of this message should be a mouse event object with subtype NSTabletProximityEventSubtype or an event of type NSTabletProximity.
NSEvent.hReturns the vendor-assigned serial number of a pointing device of a certain type.
- (NSUInteger)pointingDeviceSerialNumber
Devices of different types, such as a puck and a pen, may have the same serial number. The receiver of this message should be a mouse event object with subtype NSTabletProximityEventSubtype or an event of type NSTabletProximity.
NSEvent.hReturns a NSPointingDeviceType constant indicating the kind of pointing device associated with the receiver.
- (NSPointingDeviceType)pointingDeviceType
For example, the device could be a pen, eraser, or cursor pointing device. This method is valid for mouse events with subtype NSTabletProximityEventSubtype and for NSTabletProximity events. See “Constants” for descriptions of valid NSPointingDeviceType constants.
NSEvent.hReturns a value from 0.0 through 1.0 indicating the pressure applied to the input device (used for appropriate devices).
- (float)pressure
For devices that aren’t pressure-sensitive, the value is either 0.0 or 1.0. Raises an NSInternalInconsistencyException if sent to a nonmouse event.
For tablet pointing devices that are in proximity, the pressure value is 0.0 if they are not actually touching the tablet. As the device is pressed into the tablet, the value is increased.
NSEvent.hReturns the rotation in degrees of the tablet pointing device associated with the receiver.
- (float)rotation
Many devices do not support rotation, in which case the returned value is 0.0. This method is valid only for mouse events with subtype NSTabletPointEventSubtype and for NSTabletPoint events.
NSEvent.hReturns the subtype of the receiving event object.
- (short)subtype
Raises an NSInternalInconsistencyException if sent to an event not of type NSAppKitDefined, NSSystemDefined, NSApplicationDefined, or NSPeriodic.
NSPeriodic events don’t use this attribute.
This method is also valid for mouse events on Mac OS X v10.4 and later. See “Constants” for the predefined mouse and tablet subtypes.
NSEvent.hReturns the index of the tablet device connected to the system.
- (NSUInteger)systemTabletID
If multiple tablets are connected to the system, the system-tablet ID is incremented for each subsequent one. If there is only one tablet device, its system-tablet ID is zero. The receiver of this message should be a mouse event object with subtype NSTabletProximityEventSubtype or an event of type NSTabletProximity.
NSEvent.hReturns the USB model identifier of the tablet device associated with the receiver.
- (NSUInteger)tabletID
This method is valid for mouse events with subtype NSTabletProximityEventSubtype and for NSTabletProximity events.
NSEvent.hReports the tangential pressure on the device that generated the event represented by the receiver.
- (float)tangentialPressure
The value returned can range from -1.0 to 1.0. Tangential pressure is also known as barrel pressure. Only some pointing devices support tangential pressure. This method is valid for mouse events with subtype NSTabletPointEventSubtype and for NSTabletPoint events.
NSEvent.hReports the scaled tilt values of the pointing device that generated the event represented by the receiver.
- (NSPoint)tilt
The value returned can range from -1.0 to 1.0 for both axes. An x-coordinate value that is negative indicates a tilt to the left and a positive value indicates a tilt to the right; a y-coordinate value that is negative indicates a tilt to the top and a positive value indicates a tilt to the bottom. If the device is perfectly perpendicular to the table surface, the values are 0.0 for both axes. This method is valid for mouse events with subtype NSTabletPointEventSubtype and for NSTabletPoint events.
NSEvent.hReturns the time the receiver occurred in seconds since system startup.
- (NSTimeInterval)timestamp
NSEvent.hReturns all the NSTouch objects associated with a specific phase.
- (NSSet *)touchesMatchingPhase:(NSTouchPhase)phase inView:(NSView *)view
The touch phase for which you want touches. See “Touch Phases” for the possible values.
The view for which touches are wanted. Touches that target this view, or any of the view’s descendants will be returned. Passing nil as the view gets all touches regardless of their targeted view.
A set of applicable NSTouch objects.
This method is only valid for gesture events (gesture, magnify, swipe, rotate, etc.). Using this method a view can get all of the touches associated with a gesture without overriding the individual touch responder methods.
NSEvent.hReturns the NSTrackingArea object that generated the event represented by the receiver.
- (NSTrackingArea *)trackingArea
Returns the NSTrackingArea object that generated the event represented by the receiver. If the receiver is not a mouse-tracking event (that is, an event of type NSMouseEntered, NSMouseExited, or NSCursorUpdate), this method raises an NSInternalInconsistencyException. This method returns nil if the event was generated by a tracking rectangle (pre-Mac OS X version 10.5) instead of a NSTrackingArea object.
If no NSTrackingArea object is associated with the event because the event corresponds to a tracking rectangle installed with the NSView method addTrackingRect:owner:userData:assumeInside:, this method returns nil. Note that the trackingNumber method returns either an NSTrackingArea object or the NSTrackingRectTag constant depending on how the event was generated.
NSEvent.hReturns the identifier of a mouse-tracking event.
- (NSInteger)trackingNumber
This method returns either an NSTrackingArea object or a NSTrackingRectTag constant depending on whether the event was generated from an NSTrackingArea object or a call to addTrackingRect:owner:userData:assumeInside:. Valid mouse-tracking methods are of types NSMouseEntered, NSMouseExited, and NSCursorUpdate. This method raises an NSInternalInconsistencyException if sent to any other type of event.
The NSTrackingArea class is new with Mac OS X version 10.5
NSEvent.hReturns the type of the receiving event.
- (NSEventType)type
Returns the event type. The possible values are described in “Event Types.”
NSEvent.hReturns the unique identifier of the pointing device that generated the event represented by the receiver.
- (unsigned long long)uniqueID
Also known as tool ID, this is a unique number recorded in the chip inside every pointing device. The unique ID makes it possible to assign a specific pointing device to a specific tablet. You can also use it to “sign” documents or to restrict access to document layers to a specific pointing device. This method is valid for mouse events with subtype NSTabletProximityEventSubtype and for NSTabletProximity events.
NSEvent.hReturns data associated with a mouse-tracking event,
- (void *)userData
The returned data was assigned to the mouse-tracking event when it was set up using the NSView method addTrackingRect:owner:userData:assumeInside:. It is only valid to send this message if the receiver represents an NSMouseEntered or NSMouseExited event. Raises an NSInternalInconsistencyException if sent to any other type of event object.
NSEvent.hReturns an array of three vendor-defined NSNumber objects associated with the pointing-type event represented by the receiver.
- (id)vendorDefined
The NSNumber objects encapsulate short values that vendors may return for various reasons; see the vendor documentation for details.This method is valid for mouse events with subtype NSTabletPointEventSubtype and for NSTabletPoint events.
NSEvent.hReturns the vendor identifier of the tablet associated with the receiver.
- (NSUInteger)vendorID
The tablet is typically a USB device. This method is valid only for mouse events with subtype NSTabletProximityEventSubtype and for NSTabletProximity events.
NSEvent.hReturns a coded bit field whose set bits indicate the type of pointing device (within a vendor selection) associated with the receiver.
- (NSUInteger)vendorPointingDeviceType
See the vendor documentation for an interpretation of significant bits. This method is valid only for mouse events with subtype NSTabletProximityEventSubtype and for NSTabletProximity events.
NSEvent.hReturns the window object associated with the receiver.
- (NSWindow *)window
A periodic event, however, has no window; in this case the return value is undefined.
NSEvent.hThese constants represent the possible phases during a touch gesture.
enum {
NSTouchPhaseBegan = 1 << 0,
NSTouchPhaseMoved = 1 << 1,
NSTouchPhaseStationary = 1 << 2,
NSTouchPhaseEnded = 1 << 3,
NSTouchPhaseCancelled = 1 << 4,
NSTouchPhaseTouching = NSTouchPhaseBegan | NSTouchPhaseMoved | NSTouchPhaseStationary,
NSTouchPhaseAny = NSUIntegerMax
};
typedef NSUInteger NSTouchPhase;
NSTouchPhaseBeganA finger for a given event touched the screen.
Available in Mac OS X v10.6 and later.
Declared in NSTouch.h.
NSTouchPhaseMovedA finger for a given event moved on the screen.
Available in Mac OS X v10.6 and later.
Declared in NSTouch.h.
NSTouchPhaseStationaryA finger is touching the surface but hasn't moved since the previous event.
Available in Mac OS X v10.6 and later.
Declared in NSTouch.h.
NSTouchPhaseEndedA finger for a given event was lifted from the screen.
Available in Mac OS X v10.6 and later.
Declared in NSTouch.h.
NSTouchPhaseCancelledThe system cancelled tracking for the touch.
Available in Mac OS X v10.6 and later.
Declared in NSTouch.h.
NSTouchPhaseTouchingAn NSTouchPhaseBegan, or NSTouchPhaseMoved, or NSTouchPhaseStationary phase is in progress.
Available in Mac OS X v10.6 and later.
Declared in NSTouch.h.
NSTouchPhaseAnyAny touch phase.
Available in Mac OS X v10.6 and later.
Declared in NSTouch.h.
These constants represent various kinds of events. They are returned by type and are used as the first argument to the methods enterExitEventWithType:location:modifierFlags:timestamp:windowNumber:context:eventNumber:trackingNumber:userData:, keyEventWithType:location:modifierFlags:timestamp:windowNumber:context:characters:charactersIgnoringModifiers:isARepeat:keyCode:, mouseEventWithType:location:modifierFlags:timestamp:windowNumber:context:eventNumber:clickCount:pressure:, and otherEventWithType:location:modifierFlags:timestamp:windowNumber:context:subtype:data1:data2:.
enum {
NSLeftMouseDown = 1,
NSLeftMouseUp = 2,
NSRightMouseDown = 3,
NSRightMouseUp = 4,
NSMouseMoved = 5,
NSLeftMouseDragged = 6,
NSRightMouseDragged = 7,
NSMouseEntered = 8,
NSMouseExited = 9,
NSKeyDown = 10,
NSKeyUp = 11,
NSFlagsChanged = 12,
NSAppKitDefined = 13,
NSSystemDefined = 14,
NSApplicationDefined = 15,
NSPeriodic = 16,
NSCursorUpdate = 17,
NSScrollWheel = 22,
NSTabletPoint = 23,
NSTabletProximity = 24,
NSOtherMouseDown = 25,
NSOtherMouseUp = 26,
NSOtherMouseDragged = 27
NSEventTypeGesture = 29,
NSEventTypeMagnify = 30,
NSEventTypeSwipe = 31,
NSEventTypeRotate = 18,
NSEventTypeBeginGesture = 19,
NSEventTypeEndGesture = 20
};
typedef NSUInteger NSEventType;
NSLeftMouseDownSee “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSLeftMouseUpSee “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSRightMouseDownSee “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSRightMouseUpSee “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSOtherMouseDownSee “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.1 and later.
Declared in NSEvent.h.
NSOtherMouseUpSee “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.1 and later.
Declared in NSEvent.h.
NSMouseMovedSee “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSLeftMouseDraggedSee “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSRightMouseDraggedSee “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSOtherMouseDraggedSee “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.1 and later.
Declared in NSEvent.h.
NSMouseEnteredSee “Mouse-Tracking and Cursor-Update Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSMouseExitedSee “Mouse-Tracking and Cursor-Update Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSCursorUpdateSee “Mouse-Tracking and Cursor-Update Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSKeyDownSee “Handling Key Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSKeyUpSee “Handling Key Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSFlagsChangedSee “Handling Key Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSAppKitDefinedSee “Event Objects and Types” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSSystemDefinedSee “Event Objects and Types” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSApplicationDefinedSee “Event Objects and Types” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSPeriodicSee “Event Objects and Types” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSScrollWheelSee “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSTabletPointAn event representing the current state of a tablet pointing device, including its location, pressure, and tilt.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
NSTabletProximityAn event representing the proximity of a pointing device to its tablet.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
NSEventTypeGestureAn event that represents some type of gesture such as NSEventTypeMagnify, NSEventTypeSwipe, NSEventTypeRotate, NSEventTypeBeginGesture, or NSEventTypeEndGesture.
Available in Mac OS X v10.6 and later.
Declared in NSEvent.h.
NSEventTypeMagnifyAn event representing a pinch open or pinch close gesture.
Available in Mac OS X v10.6 and later.
Declared in NSEvent.h.
NSEventTypeSwipeAn event representing a swipe gesture.
Available in Mac OS X v10.6 and later.
Declared in NSEvent.h.
NSEventTypeRotateAn event representing a rotation gesture.
Available in Mac OS X v10.6 and later.
Declared in NSEvent.h.
NSEventTypeBeginGestureAn event that represents a gesture beginning.
Available in Mac OS X v10.6 and later.
Declared in NSEvent.h.
NSEventTypeEndGestureAn event that represents a gesture ending.
Available in Mac OS X v10.6 and later.
Declared in NSEvent.h.
These constants are masks for the events defined in “Event Types.” Pass them to the NSCell method sendActionOn: to specify when an NSCell should send its action message.
enum {
NSLeftMouseDownMask = 1 << NSLeftMouseDown,
NSLeftMouseUpMask = 1 << NSLeftMouseUp,
NSRightMouseDownMask = 1 << NSRightMouseDown,
NSRightMouseUpMask = 1 << NSRightMouseUp,
NSMouseMovedMask = 1 << NSMouseMoved,
NSLeftMouseDraggedMask = 1 << NSLeftMouseDragged,
NSRightMouseDraggedMask = 1 << NSRightMouseDragged,
NSMouseEnteredMask = 1 << NSMouseEntered,
NSMouseExitedMask = 1 << NSMouseExited,
NSKeyDownMask = 1 << NSKeyDown,
NSKeyUpMask = 1 << NSKeyUp,
NSFlagsChangedMask = 1 << NSFlagsChanged,
NSAppKitDefinedMask = 1 << NSAppKitDefined,
NSSystemDefinedMask = 1 << NSSystemDefined,
NSApplicationDefinedMask = 1 << NSApplicationDefined,
NSPeriodicMask = 1 << NSPeriodic,
NSCursorUpdateMask = 1 << NSCursorUpdate,
NSScrollWheelMask = 1 << NSScrollWheel,
NSTabletPointMask = 1 << NSTabletPoint,
NSTabletProximityMask = 1 << NSTabletProximity,
NSOtherMouseDownMask = 1 << NSOtherMouseDown,
NSOtherMouseUpMask = 1 << NSOtherMouseUp,
NSOtherMouseDraggedMask = 1 << NSOtherMouseDragged,
NSEventMaskGesture = 1 << NSEventTypeGesture,
NSEventMaskMagnify = 1 << NSEventTypeMagnify,
NSEventMaskSwipe = 1U << NSEventTypeSwipe,
NSEventMaskRotate = 1 << NSEventTypeRotate,
NSEventMaskBeginGesture = 1 << NSEventTypeBeginGesture,
NSEventMaskEndGesture = 1 << NSEventTypeEndGesture,
NSAnyEventMask = 0xffffffffU
};
NSUInteger NSEventMaskFromType(NSEventType type) { return (1 << type); };
NSLeftMouseDownMaskCorresponds to NSLeftMouseDown. See “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSLeftMouseUpMaskCorresponds to NSLeftMouseUp. See “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSRightMouseDownMaskCorresponds to NSRightMouseDown. See “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSRightMouseUpMaskCorresponds to NSRightMouseUp. See “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSOtherMouseDownMaskCorresponds to NSOtherMouseDown. See “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.1 and later.
Declared in NSEvent.h.
NSOtherMouseUpMaskCorresponds to NSOtherMouseUp. See “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.1 and later.
Declared in NSEvent.h.
NSMouseMovedMaskCorresponds to NSMouseMoved. See “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSLeftMouseDraggedMaskCorresponds to NSLeftMouseDragged. See “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSRightMouseDraggedMaskCorresponds to NSRightMouseDragged. See “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSOtherMouseDraggedMaskCorresponds to NSOtherMouseDragged. See “Handling Mouse Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.1 and later.
Declared in NSEvent.h.
NSMouseEnteredMaskCorresponds to NSMouseEntered. See See “Mouse-Tracking and Cursor-Update Events” in Cocoa Event-Handling Guide..
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSMouseExitedMaskCorresponds to NSMouseExited. See See “Mouse-Tracking and Cursor-Update Events” in Cocoa Event-Handling Guide..
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSCursorUpdateMaskCorresponds to NSCursorUpdate. See See “Mouse-Tracking and Cursor-Update Events” in Cocoa Event-Handling Guide..
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSKeyDownMaskCorresponds to NSKeyDown. See “Handling Key Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSKeyUpMaskCorresponds to NSKeyUp. See “Handling Key Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSFlagsChangedMaskCorresponds to NSFlagsChanged. See “Handling Key Events” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSAppKitDefinedMaskCorresponds to NSAppKitDefined. See “Event Objects and Types” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSSystemDefinedMaskCorresponds to NSSystemDefined. See “Event Objects and Types” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSApplicationDefinedMaskCorresponds to NSApplicationDefined. See “Event Objects and Types” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSPeriodicMaskCorresponds to NSPeriodic. See “Event Objects and Types” in Cocoa Event-Handling Guide.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSScrollWheelMaskCorresponds to NSScrollWheel. See “Handling Mouse Events” in Cocoa Event-Handling Guide..
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSTabletPointMaskCorresponds to NSTabletPoint.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
NSTabletProximityMaskCorresponds to NSTabletProximity.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
NSEventMaskGestureCorresponds to NSEventTypeGesture.
Available in Mac OS X v10.6 and later.
Declared in NSEvent.h.
NSEventMaskMagnifyCorresponds to NSEventTypeMagnify.
Available in Mac OS X v10.6 and later.
Declared in NSEvent.h.
NSEventMaskSwipeCorresponds to NSEventTypeSwipe.
Available in Mac OS X v10.6 and later.
Declared in NSEvent.h.
NSEventMaskRotateCorresponds to NSEventTypeRotate.
Available in Mac OS X v10.6 and later.
Declared in NSEvent.h.
NSEventMaskBeginGestureCorresponds to NSEventTypeBeginGesture.
Available in Mac OS X v10.6 and later.
Declared in NSEvent.h.
NSEventMaskEndGestureCorresponds to NSEventTypeEndGesture.
Available in Mac OS X v10.6 and later.
Declared in NSEvent.h.
NSAnyEventMaskCorresponds to any event mask.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
The following constants (except for NSDeviceIndependentModifierFlagsMask) represent device-independent bits found in event modifier flags:
enum {
NSAlphaShiftKeyMask = 1 << 16,
NSShiftKeyMask = 1 << 17,
NSControlKeyMask = 1 << 18,
NSAlternateKeyMask = 1 << 19,
NSCommandKeyMask = 1 << 20,
NSNumericPadKeyMask = 1 << 21,
NSHelpKeyMask = 1 << 22,
NSFunctionKeyMask = 1 << 23,
NSDeviceIndependentModifierFlagsMask = 0xffff0000U
};
NSAlphaShiftKeyMaskSet if Caps Lock key is pressed.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSShiftKeyMaskSet if Shift key is pressed.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSControlKeyMaskSet if Control key is pressed.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSAlternateKeyMaskSet if Option or Alternate key is pressed.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSCommandKeyMaskSet if Command key is pressed.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSNumericPadKeyMaskSet if any key in the numeric keypad is pressed. The numeric keypad is generally on the right side of the keyboard. This is also set if any of the arrow keys are pressed (NSUpArrowFunctionKey, NSDownArrowFunctionKey, NSLeftArrowFunctionKey, and NSRightArrowFunctionKey).
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSHelpKeyMaskSet if the Help key is pressed.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSFunctionKeyMaskSet if any function key is pressed. The function keys include the F keys at the top of most keyboards (F1, F2, and so on) and the navigation keys in the center of most keyboards (Help, Forward Delete, Home, End, Page Up, Page Down, and the arrow keys).
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSDeviceIndependentModifierFlagsMaskUsed to retrieve only the device-independent modifier flags, allowing applications to mask off the device-dependent modifier flags, including event coalescing information.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
The following constants represent pointing-device types for NSTabletProximity events or mouse events with subtype NSTabletProximityEventSubtype. The pointingDeviceType method returns one of these constants.
typedef enum {
NSUnknownPointingDevice = NX_TABLET_POINTER_UNKNOWN,
NSPenPointingDevice = NX_TABLET_POINTER_PEN,
NSCursorPointingDevice = NX_TABLET_POINTER_CURSOR,
NSEraserPointingDevice = NX_TABLET_POINTER_ERASER
} NSPointingDeviceType;
NSUnknownPointingDeviceRepresents an unknown type of pointing device.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
NSPenPointingDeviceRepresents the tip end of a stylus-like pointing device.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
NSCursorPointingDeviceRepresents a cursor (or puck-like) pointing device.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
NSEraserPointingDeviceRepresents the eraser end of a stylus-like pointing device.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
The following constants represent mouse-event subtypes for mouse and tablet events (accessed with the subtype method).
enum {
NSMouseEventSubtype = NX_SUBTYPE_DEFAULT,
NSTabletPointEventSubtype = NX_SUBTYPE_TABLET_POINT,
NSTabletProximityEventSubtype = NX_SUBTYPE_TABLET_PROXIMITY
NSTouchEventSubtype = NX_SUBTYPE_MOUSE_TOUCH
};
NSMouseEventSubtypeIndicates a purely mouse event.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
NSTabletPointEventSubtypeIndicates a tablet-pointer event; see description of NSTabletPoint.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
NSTabletProximityEventSubtypeIndicates a tablet-proximity event; see description of NSTabletProximity.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
NSTouchEventSubtypeIndicates a touch event subtype.
Available in Mac OS X v10.6 and later.
Declared in NSEvent.h.
The following constants represent button masks for NSTabletPoint events or mouse events with subtype NSTabletPointEventSubtype. The buttonMask method returns a bit mask, which you test with one or more of these constants to determine the state of the buttons on a tablet pointing device.
enum {
NSPenTipMask = NX_TABLET_BUTTON_PENTIPMASK,
NSPenLowerSideMask = NX_TABLET_BUTTON_PENLOWERSIDEMASK,
NSPenUpperSideMask = NX_TABLET_BUTTON_PENUPPERSIDEMASK
};
NSPenTipMaskThe pen tip is activated.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
NSPenLowerSideMaskThe button on the lower side of the device is activated.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
NSPenUpperSideMaskThe button on the upper side of the device is activated.
Available in Mac OS X v10.4 and later.
Declared in NSEvent.h.
These constants represent the types of events defined by the Application Kit.
enum {
NSWindowExposedEventType = 0,
NSApplicationActivatedEventType = 1,
NSApplicationDeactivatedEventType = 2,
NSWindowMovedEventType = 4,
NSScreenChangedEventType = 8,
NSAWTEventType = 16
};
NSWindowExposedEventTypeA non-retained NSWindow has been exposed.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSApplicationActivatedEventTypeThe application has been activated.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSApplicationDeactivatedEventTypeThe application has been deactivated.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSWindowMovedEventTypeAn NSWindow has moved.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSScreenChangedEventTypeAn NSWindow has changed screens.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSAWTEventTypeAn event type used to support Java applications.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
This constant denotes that the user is turning off the computer.
enum {
NSPowerOffEventType = 1
};
NSPowerOffEventTypeSpecifies that the user is turning off the computer.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
These constants represent Unicode characters (0xF700–0xF8FF) that are reserved for function keys on the keyboard. Combined in NSStrings, they are the return values of the NSEvent methods characters and charactersIgnoringModifiers and may be used in some parameters in the NSEvent method keyEventWithType:location:modifierFlags:timestamp:windowNumber:context:characters:charactersIgnoringModifiers:isARepeat:keyCode:.
enum {
NSUpArrowFunctionKey = 0xF700,
NSDownArrowFunctionKey = 0xF701,
NSLeftArrowFunctionKey = 0xF702,
NSRightArrowFunctionKey = 0xF703,
NSF1FunctionKey = 0xF704,
NSF2FunctionKey = 0xF705,
NSF3FunctionKey = 0xF706,
NSF4FunctionKey = 0xF707,
NSF5FunctionKey = 0xF708,
NSF6FunctionKey = 0xF709,
NSF7FunctionKey = 0xF70A,
NSF8FunctionKey = 0xF70B,
NSF9FunctionKey = 0xF70C,
NSF10FunctionKey = 0xF70D,
NSF11FunctionKey = 0xF70E,
NSF12FunctionKey = 0xF70F,
NSF13FunctionKey = 0xF710,
NSF14FunctionKey = 0xF711,
NSF15FunctionKey = 0xF712,
NSF16FunctionKey = 0xF713,
NSF17FunctionKey = 0xF714,
NSF18FunctionKey = 0xF715,
NSF19FunctionKey = 0xF716,
NSF20FunctionKey = 0xF717,
NSF21FunctionKey = 0xF718,
NSF22FunctionKey = 0xF719,
NSF23FunctionKey = 0xF71A,
NSF24FunctionKey = 0xF71B,
NSF25FunctionKey = 0xF71C,
NSF26FunctionKey = 0xF71D,
NSF27FunctionKey = 0xF71E,
NSF28FunctionKey = 0xF71F,
NSF29FunctionKey = 0xF720,
NSF30FunctionKey = 0xF721,
NSF31FunctionKey = 0xF722,
NSF32FunctionKey = 0xF723,
NSF33FunctionKey = 0xF724,
NSF34FunctionKey = 0xF725,
NSF35FunctionKey = 0xF726,
NSInsertFunctionKey = 0xF727,
NSDeleteFunctionKey = 0xF728,
NSHomeFunctionKey = 0xF729,
NSBeginFunctionKey = 0xF72A,
NSEndFunctionKey = 0xF72B,
NSPageUpFunctionKey = 0xF72C,
NSPageDownFunctionKey = 0xF72D,
NSPrintScreenFunctionKey = 0xF72E,
NSScrollLockFunctionKey = 0xF72F,
NSPauseFunctionKey = 0xF730,
NSSysReqFunctionKey = 0xF731,
NSBreakFunctionKey = 0xF732,
NSResetFunctionKey = 0xF733,
NSStopFunctionKey = 0xF734,
NSMenuFunctionKey = 0xF735,
NSUserFunctionKey = 0xF736,
NSSystemFunctionKey = 0xF737,
NSPrintFunctionKey = 0xF738,
NSClearLineFunctionKey = 0xF739,
NSClearDisplayFunctionKey = 0xF73A,
NSInsertLineFunctionKey = 0xF73B,
NSDeleteLineFunctionKey = 0xF73C,
NSInsertCharFunctionKey = 0xF73D,
NSDeleteCharFunctionKey = 0xF73E,
NSPrevFunctionKey = 0xF73F,
NSNextFunctionKey = 0xF740,
NSSelectFunctionKey = 0xF741,
NSExecuteFunctionKey = 0xF742,
NSUndoFunctionKey = 0xF743,
NSRedoFunctionKey = 0xF744,
NSFindFunctionKey = 0xF745,
NSHelpFunctionKey = 0xF746,
NSModeSwitchFunctionKey = 0xF747
};
NSUpArrowFunctionKeyUp Arrow key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSDownArrowFunctionKeyDown Arrow key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSLeftArrowFunctionKeyLeft Arrow key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSRightArrowFunctionKeyRight Arrow key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF1FunctionKeyF1 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF2FunctionKeyF2 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF3FunctionKeyF3 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF4FunctionKeyF4 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF5FunctionKeyF5 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF6FunctionKeyF6 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF7FunctionKeyF7 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF8FunctionKeyF8 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF9FunctionKeyF9 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF10FunctionKeyF10 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF11FunctionKeyF11 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF12FunctionKeyF12 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF13FunctionKeyF13 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF14FunctionKeyF14 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF15FunctionKeyF15 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF16FunctionKeyF16 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF17FunctionKeyF17 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF18FunctionKeyF18 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF19FunctionKeyF19 key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF20FunctionKeyF20 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF21FunctionKeyF21 keyc. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF22FunctionKeyF22 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF23FunctionKeyF23 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF24FunctionKeyF24 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF25FunctionKeyF25 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF26FunctionKeyF26 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF27FunctionKeyF27 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF28FunctionKeyF28 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF29FunctionKeyF29 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF30FunctionKeyF30 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF31FunctionKeyF31 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF32FunctionKeyF32 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF33FunctionKeyF33 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF34FunctionKeyF34 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSF35FunctionKeyF35 key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSInsertFunctionKeyInsert key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSDeleteFunctionKeyForward Delete key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSHomeFunctionKeyHome key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSBeginFunctionKeyBegin key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSEndFunctionKeyEnd key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSPageUpFunctionKeyPage Up key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSPageDownFunctionKeyPage Down key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSPrintScreenFunctionKeyPrint Screen key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSScrollLockFunctionKeyScroll Lock key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSPauseFunctionKeyPause key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSSysReqFunctionKeySystem Request key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSBreakFunctionKeyBreak key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSResetFunctionKeyReset key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSStopFunctionKeyStop key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSMenuFunctionKeyMenu key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSUserFunctionKeyUser key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSSystemFunctionKeySystem key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSPrintFunctionKeyPrint key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSClearLineFunctionKeyClear/Num Lock key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSClearDisplayFunctionKeyClear Display key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSInsertLineFunctionKeyInsert Line key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSDeleteLineFunctionKeyDelete Line key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSInsertCharFunctionKeyInsert Character key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSDeleteCharFunctionKeyDelete Character key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSPrevFunctionKeyPrevious key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSNextFunctionKeyNext key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSSelectFunctionKeySelect key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSExecuteFunctionKeyExecute key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSUndoFunctionKeyUndo key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSRedoFunctionKeyRedo key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSFindFunctionKeyFind key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSHelpFunctionKeyHelp key.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
NSModeSwitchFunctionKeyMode Switch key. Not on most Macintosh keyboards.
Available in Mac OS X v10.0 and later.
Declared in NSEvent.h.
Note that some function keys are handled at a lower level and are never seen by your application. They include the Volume Up key, Volume Down key, Volume Mute key, Eject key, and Function key found on many iBook and PowerBook computers.
Last updated: 2010-03-24