Vuo  1.2.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Enumerations | Functions
VuoModifierKey

Description

A modifier key from the keyboard that may accompany a mouse action.

Enumerations

enum  VuoModifierKey {
  VuoModifierKey_Any, VuoModifierKey_Command, VuoModifierKey_Option, VuoModifierKey_Control,
  VuoModifierKey_Shift, VuoModifierKey_None
}
 The available modifier keys (or any or none). More...
 

Functions

VuoModifierKey VuoModifierKey_makeFromJson (json_object *js)
 Decodes the JSON object js, expected to contain a string, to create a new VuoModifierKey.
 
json_objectVuoModifierKey_getJson (const VuoModifierKey value)
 Encodes value as a JSON object.
 
char * VuoModifierKey_getSummary (const VuoModifierKey value)
 Returns a brief description of value.
 
VuoList_VuoModifierKey VuoModifierKey_getAllowedValues (void)
 Returns a list of values that instances of this type can have.
 
bool VuoModifierKey_doMacEventFlagsMatch (unsigned long flags, VuoModifierKey modifierKey)
 Returns true if flags (of type CGEventFlags) contains the given modifier keys.
 
VuoModifierKey VuoModifierKey_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoModifierKey_getString (const VuoModifierKey value)
 Automatically generated function.
 
void VuoModifierKey_retain (VuoModifierKey value)
 Automatically generated function.
 
void VuoModifierKey_release (VuoModifierKey value)
 Automatically generated function.
 

Enumeration Type Documentation

The available modifier keys (or any or none).

Function Documentation

bool VuoModifierKey_doMacEventFlagsMatch ( unsigned long  flags,
VuoModifierKey  modifierKey 
)

Returns true if flags (of type CGEventFlags) contains the given modifier keys.

VuoList_VuoModifierKey VuoModifierKey_getAllowedValues ( void  )

Returns a list of values that instances of this type can have.

struct json_object * VuoModifierKey_getJson ( const VuoModifierKey  value)
read

Encodes value as a JSON object.

char* VuoModifierKey_getString ( const VuoModifierKey  value)

Automatically generated function.

char * VuoModifierKey_getSummary ( const VuoModifierKey  value)

Returns a brief description of value.

VuoModifierKey VuoModifierKey_makeFromJson ( json_object js)

Decodes the JSON object js, expected to contain a string, to create a new VuoModifierKey.

VuoModifierKey VuoModifierKey_makeFromString ( const char *  str)

Automatically generated function.

void VuoModifierKey_release ( VuoModifierKey  value)

Automatically generated function.

void VuoModifierKey_retain ( VuoModifierKey  value)

Automatically generated function.