CPEvent Class Reference

#import <CPEvent.h>

Inheritance diagram for CPEvent:

Instance Methods
(int)	- buttonNumber
(CPString)	- characters
(CPString)	- charactersIgnoringModifiers
(int)	- clickCount
(int)	- data1
(int)	- data2
(float)	- deltaX
(float)	- deltaY
(float)	- deltaZ
(CPString)	- description
(CGPoint)	- globalLocation
(BOOL)	- isARepeat
(unsigned short)	- keyCode
(CGPoint)	- locationInWindow
(unsigned)	- modifierFlags
(float)	- pressure
(CPTimeInterval)	- timestamp
(CPEventType)	- type
(CPWindow)	- window
(int)	- windowNumber
Instance Methods inherited from CPObject
(void)	- addObserver:forKeyPath:options:context:
(void)	- applyChange:toKeyPath:
(id)	- autorelease
(id)	- awakeAfterUsingCoder:
(void)	- awakeFromCib
(void)	- bind:toObject:withKeyPath:options:
(Class)	- classForCoder
(Class)	- classForKeyedArchiver
(CPString)	- className
(id)	- copy
(void)	- dealloc
(CPDictionary)	- dictionaryWithValuesForKeys:
(void)	- didChange:valuesAtIndexes:forKey:
(void)	- didChangeValueForKey:
(void)	- didChangeValueForKey:withSetMutation:usingObjects:
(void)	- doesNotRecognizeSelector:
(CPArray)	- exposedBindings
(id)	- forwardingTargetForSelector:
(void)	- forwardInvocation:
(unsigned)	- hash
(BOOL)	- implementsSelector:
(CPDictionary)	- infoForBinding:
(id)	- init
(BOOL)	- isEqual:
(BOOL)	- isKindOfClass:
(BOOL)	- isMemberOfClass:
(BOOL)	- isProxy
(IMP)	- methodForSelector:
(CPMethodSignature)	- methodSignatureForSelector:
(id)	- mutableArrayValueForKey:
(id)	- mutableArrayValueForKeyPath:
(id)	- mutableCopy
(id)	- mutableSetValueForKey:
(id)	- mutableSetValueForKeyPath:
(id)	- performSelector:
(id)	- performSelector:withObject:
(id)	- performSelector:withObject:withObject:
(id)	- performSelector:withObjects:
(void)	- release
(void)	- removeObserver:forKeyPath:
(id)	- replacementObjectForArchiver:
(id)	- replacementObjectForCoder:
(id)	- replacementObjectForKeyedArchiver:
(BOOL)	- respondsToSelector:
(id)	- retain
(id)	- self
(void)	- setValue:forKey:
(void)	- setValue:forKeyPath:
(void)	- setValue:forUndefinedKey:
(void)	- setValuesForKeysWithDictionary:
(CPString)	- UID
(void)	- unbind:
(Class)	- valueClassForBinding:
(id)	- valueForKey:
(id)	- valueForKeyPath:
(id)	- valueForUndefinedKey:
(void)	- willChange:valuesAtIndexes:forKey:
(void)	- willChangeValueForKey:
(void)	- willChangeValueForKey:withSetMutation:usingObjects:

Class Methods
(CPTimeInterval)	+ currentTimestamp
(CPEvent)	+ keyEventWithType:location:modifierFlags:timestamp:windowNumber:context:characters:charactersIgnoringModifiers:isARepeat:keyCode:
(id)	+ mouseEventWithType:location:modifierFlags:timestamp:windowNumber:context:eventNumber:clickCount:pressure:
(CGPoint)	+ mouseLocation
(CPEvent)	+ otherEventWithType:location:modifierFlags:timestamp:windowNumber:context:subtype:data1:data2:
(void)	+ startPeriodicEventsAfterDelay:withPeriod:
(void)	+ stopPeriodicEvents
Class Methods inherited from CPObject
(BOOL)	+ accessInstanceVariablesDirectly
(id)	+ alloc
(id)	+ allocWithCoder:
(BOOL)	+ automaticallyNotifiesObserversForKey:
(Class)	+ class
(void)	+ exposeBinding:
(void)	+ initialize
(IMP)	+ instanceMethodForSelector:
(BOOL)	+ instancesRespondToSelector:
(BOOL)	+ isSubclassOfClass:
(CPSet)	+ keyPathsForValuesAffectingValueForKey:
(void)	+ load
(id)	+ new
(void)	+ setVersion:
(Class)	+ superclass
(int)	+ version

Additional Inherited Members
Instance Variables inherited from CPObject
Class	isa

Detailed Description

CPEvent encapsulates the details of a Cappuccino keyboard or mouse event.

Definition at line 2 of file CPEvent.h.

Method Documentation

- (int) buttonNumber

implementation

Returns the button number for the mouse that generated the event.

Definition at line 439 of file CPEvent.j.

- (CPString) characters

implementation

Returns the characters associated with this event (keyboard only).

Exceptions

CPInternalInconsistencyException

if this method is called on a non-key event

Definition at line 460 of file CPEvent.j.

- (CPString) charactersIgnoringModifiers

implementation

Returns the character ignoring any modifiers (except shift).

Exceptions

CPInternalInconsistencyException

if this method is called on a non-key event

Definition at line 470 of file CPEvent.j.

- (int) clickCount

implementation

Returns the number of clicks that caused this event (mouse only).

Definition at line 450 of file CPEvent.j.

+ (CPTimeInterval) currentTimestamp

implementation

Returns the current time in fractional seconds since startup.

Definition at line 216 of file CPEvent.j.

- (int) data1

implementation

Definition at line 520 of file CPEvent.j.

- (int) data2

implementation

Definition at line 525 of file CPEvent.j.

- (float) deltaX

implementation

Returns the change in the x-axis for a mouse event.

Definition at line 534 of file CPEvent.j.

- (float) deltaY

implementation

Returns the change in the y-axis for a mouse event.

Definition at line 542 of file CPEvent.j.

- (float) deltaZ

implementation

Returns the change in the x-axis for a mouse event.

Definition at line 550 of file CPEvent.j.

- (CPString) description

implementation

Returns a human readable string describing the receiver

Reimplemented from CPObject.

Definition at line 643 of file CPEvent.j.

- (CGPoint) globalLocation

implementation

Definition at line 381 of file CPEvent.j.

- (BOOL) isARepeat

implementation

Returns YES if the keyboard event was caused by the key being held down.

Exceptions

CPInternalInconsistencyException

if this method is called on a non-key event

Definition at line 480 of file CPEvent.j.

- (unsigned short) keyCode

implementation

Returns the key's key code.

Exceptions

CPInternalInconsistencyException

if this method is called on a non-key event

Definition at line 490 of file CPEvent.j.

+ (CPEvent) keyEventWithType: (CPEventType)  anEventType location: (CGPoint)  aPoint modifierFlags: (unsigned int)  modifierFlags timestamp: (CPTimeInterval)  aTimestamp windowNumber: (int)  aWindowNumber context: (CPGraphicsContext)  aGraphicsContext characters: (CPString)  characters charactersIgnoringModifiers: (CPString)  unmodCharacters isARepeat: (BOOL)  repeatKey keyCode: (unsigned short)  code

implementation

Creates a new keyboard event.

Parameters

anEventType	the event type. Must be one of CPKeyDown, CPKeyUp or CPFlagsChanged
aPoint	the location of the cursor in the window specified by aWindowNumber
modifierFlags	a bitwise combination of the modifiers specified in the CPEvent globals
aTimestamp	the time the event occurred
aWindowNumber	the number of the CPWindow where the event occurred
aGraphicsContext	the graphics context where the event occurred
characters	the characters associated with the event
unmodCharacters	the string of keys pressed without the presence of any modifiers other than Shift
repeatKey	YES if this is caused by the system repeat as opposed to the user pressing the key again
code	a number associated with the keyboard key of this event

Exceptions

CPInternalInconsistencyException

if anEventType is not a CPKeyDown, CPKeyUp or CPFlagsChanged

Returns

the keyboard event

Definition at line 238 of file CPEvent.j.

- (CGPoint) locationInWindow

implementation

Returns the location of the mouse (for mouse events). If the receiver is not a mouse event, it returns nil. If window returns nil, then the mouse coordinates will be based on the screen coordinates. Otherwise, the coordinates are relative to the window's coordinates.

Returns

the location of the mouse, or nil for non-mouse events.

Definition at line 376 of file CPEvent.j.

- (unsigned) modifierFlags

implementation

Returns event information as a bit mask.

Provided by category CPEvent(CPApplicationModifierFlags).

Definition at line 395 of file CPEvent.j.

+ (id) mouseEventWithType: (CPEventType)  anEventType location: (CGPoint)  aPoint modifierFlags: (unsigned)  modifierFlags timestamp: (CPTimeInterval)  aTimestamp windowNumber: (int)  aWindowNumber context: (CPGraphicsContext)  aGraphicsContext eventNumber: (int)  anEventNumber clickCount: (int)  aClickCount pressure: (float)  aPressure

implementation

Creates a new mouse event.

Parameters

anEventType	the event type
aPoint	the location of the cursor in the window specified by aWindowNumber
modifierFlags	a bitwise combination of the modifiers specified in the CPEvent globals
aTimestamp	the time the event occurred
aWindowNumber	the number of the CPWindow where the event occurred
aGraphicsContext	the graphics context where the event occurred
anEventNumber	a number for this event
aClickCount	the number of clicks that caused this event
aPressure	the amount of pressure applied to the input device (ranges from 0.0 to 1.0)

Exceptions

CPInternalInconsistencyException

if an invalid event type is provided

Returns

the new mouse event

Definition at line 262 of file CPEvent.j.

+ (CGPoint) mouseLocation

implementation

Definition at line 495 of file CPEvent.j.

+ (CPEvent) otherEventWithType: (CPEventType)  anEventType location: (CGPoint)  aLocation modifierFlags: (unsigned)  modifierFlags timestamp: (CPTimeInterval)  aTimestamp windowNumber: (int)  aWindowNumber context: (CPGraphicsContext)  aGraphicsContext subtype: (short)  aSubtype data1: (int)  aData1 data2: (int)  aData2

implementation

Creates a new custom event.

Parameters

anEventType	the event type. Must be one of CPAppKitDefined, CPSystemDefined, CPApplicationDefined or CPPeriodic
aLocation	the location of the cursor in the window specified by aWindowNumber
modifierFlags	a bitwise combination of the modifiers specified in the CPEvent globals
aTimestamp	the time the event occurred
aWindowNumber	the number of the CPWindow where the event occurred
aGraphicsContext	the graphics context where the event occurred
aSubtype	a numeric identifier to differentiate this event from other custom events
aData1	more data that describes the event
aData2	even more data that describes the event

Exceptions

CPInternalInconsistencyException

if an invalid event type is provided

Returns

the new custom event

Definition at line 285 of file CPEvent.j.

- (float) pressure

implementation

Definition at line 507 of file CPEvent.j.

+ (void) startPeriodicEventsAfterDelay: (CPTimeInterval)  aDelay withPeriod: (CPTimeInterval)  aPeriod

implementation

Generates periodic events every aPeriod seconds.

Parameters

aDelay	the number of seconds before the first event
aPeriod	the length of time in seconds between successive events

Definition at line 622 of file CPEvent.j.

+ (void) stopPeriodicEvents

implementation

Stops the periodic events from being generated.

Definition at line 633 of file CPEvent.j.

- (CPTimeInterval) timestamp

implementation

Returns the time the event occurred in seconds since startup.

Definition at line 403 of file CPEvent.j.

- (CPEventType) type

implementation

Returns the type of event.

Definition at line 411 of file CPEvent.j.

- (CPWindow) window

implementation

Returns the event's associated window.

Definition at line 419 of file CPEvent.j.

- (int) windowNumber

implementation

The number of the window associated with the event.

Definition at line 430 of file CPEvent.j.

---

The documentation for this class was generated from the following files:

• AppKit/CPEvent.h
• AppKit/CPEvent.j