Returns a new NSEvent
object describing a key event.
SDK
- macOS 10.0+
Framework
- App
Kit
Declaration
+ (NSEvent *)keyEventWithType:(NSEvent Type)type location:(NSPoint)location modifierFlags:(NSEvent Modifier Flags)flags timestamp:(NSTime Interval)time windowNumber:(NSInteger)wNum context:(NSGraphics Context *)unusedPassNil characters:(NSString *)keys charactersIgnoringModifiers:(NSString *)ukeys isARepeat:(BOOL)flag keyCode:(unsigned short)code;
Parameters
type
One of the following event-type constants:
NSKey
,Down NSKey
,Up NSFlags
. If anything else is specified, anChanged NSInternal
is raised.Inconsistency Exception location
The cursor location in the base coordinate system of the window specified by
window
.Num flags
An integer bit field containing any of the modifier key masks described in Getting Unicode Values, combined using the C bitwise OR operator.
time
The time the event occurred in seconds since system startup.
windowNum
An integer that identifies the window device associated with the event, which is associated with the
NSWindow
that will receive the event.context
The display graphics context of the event.
characters
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.
unmodCharacters
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.
repeatKey
YES
if the key event is a repeat caused by the user holding the key down,NO
if the key event is new.code
A number that identifies the keyboard key associated with the key event. Its value is hardware-independent.
Return Value
The created NSEvent
instance or nil
if the instance could not be created.