Vuo 2.4.4
|
A key position on the keyboard.
For example, the top left letter key on an English keyboard ('Q') and the top left letter key on a French keyboard ('A') would have the same VuoKey value.
Enumerations | |
enum | VuoKey { VuoKey_Any , VuoKey_A , VuoKey_S , VuoKey_D , VuoKey_F , VuoKey_H , VuoKey_G , VuoKey_Z , VuoKey_X , VuoKey_C , VuoKey_V , VuoKey_B , VuoKey_Q , VuoKey_W , VuoKey_E , VuoKey_R , VuoKey_Y , VuoKey_T , VuoKey_1 , VuoKey_2 , VuoKey_3 , VuoKey_4 , VuoKey_6 , VuoKey_5 , VuoKey_Equal , VuoKey_9 , VuoKey_7 , VuoKey_Minus , VuoKey_8 , VuoKey_0 , VuoKey_RightBracket , VuoKey_O , VuoKey_U , VuoKey_LeftBracket , VuoKey_I , VuoKey_P , VuoKey_L , VuoKey_J , VuoKey_Quote , VuoKey_K , VuoKey_Semicolon , VuoKey_Backslash , VuoKey_Comma , VuoKey_Slash , VuoKey_N , VuoKey_M , VuoKey_Period , VuoKey_Grave , VuoKey_KeypadDecimal , VuoKey_KeypadMultiply , VuoKey_KeypadPlus , VuoKey_KeypadClear , VuoKey_KeypadDivide , VuoKey_KeypadEnter , VuoKey_KeypadMinus , VuoKey_KeypadEquals , VuoKey_Keypad0 , VuoKey_Keypad1 , VuoKey_Keypad2 , VuoKey_Keypad3 , VuoKey_Keypad4 , VuoKey_Keypad5 , VuoKey_Keypad6 , VuoKey_Keypad7 , VuoKey_Keypad8 , VuoKey_Keypad9 , VuoKey_Return , VuoKey_Tab , VuoKey_Space , VuoKey_Delete , VuoKey_Escape , VuoKey_Command , VuoKey_Shift , VuoKey_CapsLock , VuoKey_Option , VuoKey_Control , VuoKey_RightShift , VuoKey_RightOption , VuoKey_RightControl , VuoKey_Function , VuoKey_F17 , VuoKey_VolumeUp , VuoKey_VolumeDown , VuoKey_Mute , VuoKey_F18 , VuoKey_F19 , VuoKey_F20 , VuoKey_F5 , VuoKey_F6 , VuoKey_F7 , VuoKey_F3 , VuoKey_F8 , VuoKey_F9 , VuoKey_F11 , VuoKey_F13 , VuoKey_F16 , VuoKey_F14 , VuoKey_F10 , VuoKey_F12 , VuoKey_F15 , VuoKey_Help , VuoKey_Home , VuoKey_PageUp , VuoKey_ForwardDelete , VuoKey_F4 , VuoKey_End , VuoKey_F2 , VuoKey_PageDown , VuoKey_F1 , VuoKey_LeftArrow , VuoKey_RightArrow , VuoKey_DownArrow , VuoKey_UpArrow , VuoKey_Yen , VuoKey_Underscore , VuoKey_KeypadComma , VuoKey_Eisu , VuoKey_Kana } |
Each value of this type represents a key position on the keyboard. More... | |
Functions | |
VuoKey | VuoKey_makeFromJson (json_object *js) |
Decodes the JSON object js , expected to contain a string, to create a new VuoKey . | |
json_object * | VuoKey_getJson (const VuoKey value) |
Encodes value as a JSON object. | |
char * | VuoKey_getSummary (const VuoKey value) |
Returns a string representation of the key as it would be interpreted in the user's keyboard layout. | |
VuoList_VuoKey | VuoKey_getAllowedValues (void) |
Returns a list of values that instances of this type can have. | |
char * | VuoKey_getCharactersForMacVirtualKeyCode (unsigned short keyCode, unsigned long flags, unsigned int *deadKeyState) |
Returns the Unicode characters that would be typed by a key press. | |
VuoKey | VuoKey_makeFromMacVirtualKeyCode (unsigned short keyCode) |
Returns the VuoKey that corresponds to the given virtual key code. | |
bool | VuoKey_doesMacVirtualKeyCodeMatch (unsigned short keyCode, VuoKey key) |
Returns true if the virtual key code matches the given key. | |
char * | VuoKey_getString (const VuoKey value) |
Automatically generated function. | |
void | VuoKey_retain (VuoKey value) |
Automatically generated function. | |
void | VuoKey_release (VuoKey value) |
Automatically generated function. | |
enum VuoKey |
bool VuoKey_doesMacVirtualKeyCodeMatch | ( | unsigned short | keyCode, |
VuoKey | key | ||
) |
VuoList_VuoKey VuoKey_getAllowedValues | ( | void | ) |
char * VuoKey_getCharactersForMacVirtualKeyCode | ( | unsigned short | keyCode, |
unsigned long | flags, | ||
unsigned int * | deadKeyState | ||
) |
Returns the Unicode characters that would be typed by a key press.
keyCode | The virtual key code. |
flags | The event flags (of type CGEventFlags ) for the key press. |
deadKeyState | To capture key combinations (e.g. Option-E-E for "é"), pass a reference to the same integer variable on consecutive calls to this function. Before the first call, you should initialize the variable to 0. |
This function may be called from any thread.
struct json_object * VuoKey_getJson | ( | const VuoKey | value | ) |
char * VuoKey_getString | ( | const VuoKey | value | ) |
Automatically generated function.
char * VuoKey_getSummary | ( | const VuoKey | value | ) |
VuoKey VuoKey_makeFromJson | ( | json_object * | js | ) |
VuoKey VuoKey_makeFromMacVirtualKeyCode | ( | unsigned short | keyCode | ) |
void VuoKey_release | ( | VuoKey | value | ) |
Automatically generated function.
void VuoKey_retain | ( | VuoKey | value | ) |
Automatically generated function.