Up
Authors
- Scott Christley (
scottc@net-community.com)
-
- Ovidiu Predescu (
ovidiu@net-community.com)
-
- Felipe A. Rodriguez (
far@ix.netcom.com)
-
Date: Generated at 2023-12-22 15:07:50 -0500
The event class
Copyright: (C) 1996 Free Software Foundation, Inc.
- Declared in:
- AppKit/NSEvent.h
- Conforms to:
- NSCoding
- NSCopying
Availability: OpenStep
Description forthcoming.
Instance Variables
Method summary
+ (NSTimeInterval)
doubleClickInterval;
Availability: MacOS-X 10.6.0
Description forthcoming.
+ (
NSEvent*)
enterExitEventWithType: (
NSEventType)type
location: (NSPoint)location
modifierFlags: (
NSUInteger)flags
timestamp: (NSTimeInterval)time
windowNumber: (NSInteger)windowNum
context: (
NSGraphicsContext*)context
eventNumber: (NSInteger)eventNum
trackingNumber: (NSInteger)trackingNum
userData: (void*)userData;
Availability: OpenStep
Description forthcoming.
+ (
NSEvent*)
eventWithEventRef: (const void*)eventRef;
Availability: MacOS-X 10.5.0
Description forthcoming.
+ (BOOL)
isMouseCoalescingEnabled;
Availability: MacOS-X 10.5.0
Description forthcoming.
+ (
NSEvent*)
keyEventWithType: (
NSEventType)type
location: (NSPoint)location
modifierFlags: (
NSUInteger)flags
timestamp: (NSTimeInterval)time
windowNumber: (NSInteger)windowNum
context: (
NSGraphicsContext*)context
characters: (NSString*)keys
charactersIgnoringModifiers: (NSString*)ukeys
isARepeat: (BOOL)repeatKey
keyCode: (unsigned short)code;
Availability: OpenStep
Description forthcoming.
+ (NSTimeInterval)
keyRepeatDelay;
Availability: MacOS-X 10.6.0
Description forthcoming.
+ (NSTimeInterval)
keyRepeatInterval;
Availability: MacOS-X 10.6.0
Description forthcoming.
+ (
NSEvent*)
mouseEventWithType: (
NSEventType)type
location: (NSPoint)location
modifierFlags: (
NSUInteger)flags
timestamp: (NSTimeInterval)time
windowNumber: (NSInteger)windowNum
context: (
NSGraphicsContext*)context
eventNumber: (NSInteger)eventNum
clickCount: (NSInteger)clickNum
pressure: (float)pressureValue;
Availability: OpenStep
Description forthcoming.
+ (
NSEvent*)
mouseEventWithType: (
NSEventType)type
location: (NSPoint)location
modifierFlags: (
NSUInteger)flags
timestamp: (NSTimeInterval)time
windowNumber: (NSInteger)windowNum
context: (
NSGraphicsContext*)context
eventNumber: (NSInteger)eventNum
clickCount: (NSInteger)clickNum
pressure: (float)pressureValue
buttonNumber: (NSInteger)buttonNum
deltaX: (CGFloat)deltaX
deltaY: (CGFloat)deltaY
deltaZ: (CGFloat)deltaZ;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.
+ (NSPoint)
mouseLocation;
Availability: OpenStep
Returns the current mouse location.
+ (
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;
Availability: OpenStep
Description forthcoming.
+ (
NSUInteger)
pressedMouseButtons;
Availability: MacOS-X 10.6.0
Description forthcoming.
+ (void)
setMouseCoalescingEnabled: (BOOL)flag;
Availability: MacOS-X 10.5.0
Description forthcoming.
+ (void)
startPeriodicEventsAfterDelay: (NSTimeInterval)delaySeconds
withPeriod: (NSTimeInterval)periodSeconds;
Availability: OpenStep
Description forthcoming.
+ (void)
stopPeriodicEvents;
Availability: OpenStep
Description forthcoming.
- (NSInteger)
absoluteX;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (NSInteger)
absoluteY;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (NSInteger)
absoluteZ;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (
NSEventMask)
associatedEventsMask;
Availability: MacOS-X 10.3.0
Description forthcoming.
- (
NSEventButtonMask)
buttonMask;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (NSInteger)
buttonNumber;
Availability: MacOS-X 10.0.0
Returns the button number for the mouse button
pressed in a mouse event. Intended primarily for
the case where a mouse has three or more buttons, and
you want to know which button an 'other' mouse event
refers to.
- (
NSUInteger)
capabilityMask;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (NSString*)
characters;
Availability: OpenStep
Returns the string of characters for a keyboard
event.
Raises an
NSInternalInconsistencyException
if applied to any other type of event.
- (NSString*)
charactersIgnoringModifiers;
Availability: OpenStep
Returns the string of characters for a keyboard
event, as if no modifier keys had been pressed when
the keyboard event occirred.
Raises an
NSInternalInconsistencyException
if applied to any other type of event.
- (NSInteger)
clickCount;
Availability: OpenStep
Return the number of clicks associated with the
mouse down or up event. This method is not applicable
for any event type other than a mouse down or mouse up.
Raises an NSInternalInconsistencyException if
applied to any other type of event.
- (
NSGraphicsContext*)
context;
Availability: OpenStep
Returns the graphics context for which this event
was generated.
- (NSInteger)
data1;
Availability: OpenStep
Returns the 'data1' item associated with the event.
Raises NSInternalInconsistencyException if
the event is not of type NSAppKitDefined,
NSSystemDefined, NSApplicationDefined, or
NSPeriodic
- (NSInteger)
data2;
Availability: OpenStep
Returns the 'data2' item associated with the event.
Raises NSInternalInconsistencyException if
the event is not of type NSAppKitDefined,
NSSystemDefined, NSApplicationDefined, or
NSPeriodic
- (CGFloat)
deltaX;
Availability: MacOS-X 10.0.0
Returns the movement of the mouse on the X axis.
This method is only valid for NSMouseMoved,
NS*MouseDragged and NSScrollWheel events,
otherwise it will return 0.
- (CGFloat)
deltaY;
Availability: MacOS-X 10.0.0
Returns the movement of the mouse on the Y axis.
This method is only valid for NSMouseMoved,
NS*MouseDragged and NSScrollWheel events,
otherwise it will return 0.
- (CGFloat)
deltaZ;
Availability: MacOS-X 10.0.0
Returns the movement of the mouse on the Z axis.
This method is only valid for NSMouseMoved,
NS*MouseDragged and NSScrollWheel events,
otherwise it will return 0.
The value returned is 0.0 in most cases.
- (
NSUInteger)
deviceID;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (NSInteger)
eventNumber;
Availability: OpenStep
Returns the event number associated with any mouse
event or tracking event. Event numbers are allocated
sequentially when the system creates these
events.
Raises an
NSInternalInconsistencyException
if applied to any other type of event.
- (const void*)
eventRef;
Availability: MacOS-X 10.5.0
Description forthcoming.
- (BOOL)
isARepeat;
Availability: OpenStep
Returns a flag to say if this is a keyboard repeat
event.
Raises an
NSInternalInconsistencyException
if applied to any other type of event than an NSKeyUp or
NSKeyDown.
- (BOOL)
isEnteringProximity;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (unsigned short)
keyCode;
Availability: OpenStep
Returns the numeric key code of a keyboard event.
Raises an NSInternalInconsistencyException if
applied to any other type of event than an NSKeyUp
or NSKeyDown.
- (NSPoint)
locationInWindow;
Availability: OpenStep
Returns the window location for which this event
was generated (in the base coordinate system of the
window).
- (
NSEventModifierFlags)
modifierFlags;
Availability: OpenStep
Returns the modifier flag bits associated with the
event.
- (
NSEventPhase)
momentumPhase;
Availability: MacOS-X 10.7.0
Description forthcoming.
- (
NSEventPhase)
phase;
Availability: MacOS-X 10.7.0
Description forthcoming.
- (
NSUInteger)
pointingDeviceID;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (
NSUInteger)
pointingDeviceSerialNumber;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (float)
pressure;
Availability: OpenStep
Returns the pressure associated with a mouse event.
This is a value in the range 0.0 to 1.0 and for mormal
mouse events should be set to one of those extremes.
This is used by pressure sensitive input devices.
Raises an NSInternalInconsistencyException if
applied to any other type of event than a mouse
event.
- (float)
rotation;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (short)
subtype;
Availability: OpenStep
Returns the 'subtype' item associated with the
event.
Raises
NSInternalInconsistencyException
if the event is not of type NSAppKitDefined,
NSSystemDefined, NSApplicationDefined,
NSPeriodic or a mouve event.
- (
NSUInteger)
systemTabletID;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (
NSUInteger)
tabletID;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (float)
tangentialPressure;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (NSPoint)
tilt;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (NSTimeInterval)
timestamp;
Availability: OpenStep
Returns the time interval since system startup at
which this event was generated.
- (NSInteger)
trackingNumber;
Availability: OpenStep
Returns a number identifying the tracking rectangle
entered or exited.
Raises an
NSInternalInconsistencyException
if applied to any other type of event than a mouse
entered or exited event.
- (
NSEventType)
type;
Availability: OpenStep
returns the type of this event.
- (unsigned long long)
uniqueID;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (void*)
userData;
Availability: OpenStep
Returns usder data associated with a tracking
event... the data assigned to the tracking
rectangle concerned when it was created..
Raises an NSInternalInconsistencyException if
applied to any other type of event than a mouse
entered or exited event.
- (id)
vendorDefined;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (
NSUInteger)
vendorID;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (
NSUInteger)
vendorPointingDeviceType;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (
NSWindow*)
window;
Availability: OpenStep
Returns the window for which this event was
generated.
Periodic events have no
associated window, and you should not call this
method for those events.
- (NSInteger)
windowNumber;
Availability: OpenStep
Returns the window number of the window for which
this event was generated.
Periodic events have
no associated window, and you should not call this
method for those events.
Instance Variables for NSEvent Class
@protected NSGraphicsContext* event_context;
Availability: OpenStep
Description forthcoming.
@protected NSTimeInterval event_time;
Availability: OpenStep
Description forthcoming.
@protected NSEventType event_type;
Availability: OpenStep
Description forthcoming.
@protected NSPoint location_point;
Availability: OpenStep
Description forthcoming.
@protected NSUInteger modifier_flags;
Availability: OpenStep
Description forthcoming.
@protected union _MB_event_data union _MB_event_data;
Availability: OpenStep
Description forthcoming.
@protected NSInteger window_num;
Availability: OpenStep
Description forthcoming.
Up