Name

kOfxPropKeySym — Property used to indicate which a key on the keyboard or a button on a button device has been pressed

Synopsis

#include "/ofxKeySyms.h"
#define kOfxPropKeySym "kOfxPropKeySym"

Type

kOfxPropKeySym is of type int, and has only a single dimension.

Property Set

This is a property that belongs to the an read only in argument for the actions kOfxInteractActionKeyDown, kOfxInteractActionKeyUp and kOfxInteractActionKeyRepeat..

Valid Values

one of any specified by #defines in the file ofxKeySyms.h.

Description

Property used to indicate which a key on the keyboard or a button on a button device has been pressed

This property represents a raw key press, it does not represent the 'character value' of the key.

This property is associated with a kOfxPropKeyString property, which encodes the UTF8 value for the keypress/button press. Some keys (for example arrow keys) have no UTF8 equivalant.

Some keys, especially on non-english language systems, may have a UTF8 value, but m not a keysym values, in these cases, the keysym will have a value of kOfxKey_Unknown, but the kOfxPropKeyString property will still be set with the UTF8 value.