Initializer

init(keyboardEventSource:virtualKey:keyDown:)

Returns a new Quartz keyboard event.

Declaration

init?(keyboardEventSource source: CGEventSource?, virtualKey: CGKeyCode, keyDown: Bool)

Parameters

source

An event source taken from another event, or NULL.

virtualKey

The virtual key code for the event.

keyDown

Pass true to specify that the key position is down. To specify that the key position is up, pass false. This value is used to determine the type of the keyboard event—see CGEventType.

Return Value

A new keyboard event, or NULL if the event could not be created. When you no longer need the event, you should release it using the function CFRelease.

Discussion

All keystrokes needed to generate a character must be entered, including modifier keys. For example, to produce a 'Z', the SHIFT key must be down, the 'z' key must go down, and then the SHIFT and 'z' key must be released:

CGEventRef event1, event2, event3, event4;
event1 = CGEventCreateKeyboardEvent (NULL, (CGKeyCode)56, true);
event2 = CGEventCreateKeyboardEvent (NULL, (CGKeyCode)6, true);
event3 = CGEventCreateKeyboardEvent (NULL, (CGKeyCode)6, false);
event4 = CGEventCreateKeyboardEvent (NULL, (CGKeyCode)56, false);

See Also

Working With Events

class var typeID: CFTypeID

Returns the type identifier for the opaque type CGEventRef.

init?(source: CGEventSource?)

Returns a new Quartz event.

var data: CFData?

Returns a flattened data representation of a Quartz event.

init?(withDataAllocator: CFAllocator?, data: CFData?)

Returns a Quartz event created from a flattened data representation of the event.

func copy() -> CGEvent?

Returns a copy of an existing Quartz event.

init?(event: CGEvent?)

Returns a Quartz event source created from an existing Quartz event.

func setSource(CGEventSource?)

Sets the event source of a Quartz event.

var type: CGEventType

Returns the event type of a Quartz event (left mouse down, for example).

var timestamp: CGEventTimestamp

Returns the timestamp of a Quartz event.

var location: CGPoint

Returns the location of a Quartz mouse event.

var unflippedLocation: CGPoint

Returns the location of a Quartz mouse event.

var flags: CGEventFlags

Returns the event flags of a Quartz event.

func keyboardSetUnicodeString(stringLength: Int, unicodeString: UnsafePointer<UniChar>?)

Sets the Unicode string associated with a Quartz keyboard event.

func getIntegerValueField(CGEventField) -> Int64

Returns the integer value of a field in a Quartz event.

func setIntegerValueField(CGEventField, value: Int64)

Sets the integer value of a field in a Quartz event.

func getDoubleValueField(CGEventField) -> Double

Returns the floating-point value of a field in a Quartz event.

func setDoubleValueField(CGEventField, value: Double)

Sets the floating-point value of a field in a Quartz event.