Type

kOfxPropKeyString is of type C string , 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

a UTF8 string representing a single character, or the empty string.

Description

This property encodes a single keypresses that generates a unicode code point. The value is stored as a UTF8 string.

This property represents the UTF8 encode value of a single key press by a user in an OFX interact.

This property is associated with a kOfxPropKeySym which represents an integer value for the key press. Some keys (for example arrow keys) have no UTF8 equivalant, in which case this is set to the empty string "", and the associate kOfxPropKeySym is set to the equivilant raw key press.

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.