VuoModifierKey

Description

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

Enumerations
enum	VuoModifierKey {   VuoModifierKey_Any = 0xFFFF, VuoModifierKey_Command = 0x10, VuoModifierKey_Option = 0x8, VuoModifierKey_Control = 0x4,   VuoModifierKey_Shift = 0x2, VuoModifierKey_None = 0x0 }
	The available modifier keys (or any or none). More...

Functions
VuoModifierKey	VuoModifierKey_makeFromJson (json_object *js)
json_object *	VuoModifierKey_getJson (const VuoModifierKey value)
char *	VuoModifierKey_getSummary (const VuoModifierKey value)
VuoList_VuoModifierKey	VuoModifierKey_getAllowedValues (void)
	Returns a list of values that instances of this type can have. More...
bool	VuoModifierKey_doMacEventFlagsMatch (unsigned long flags, VuoModifierKey modifierKey)
	Returns true if flags (of type CGEventFlags) contains the given modifier keys. More...
VuoModifierKey	VuoModifierKey_makeFromString (const char *str)
	Automatically generated function. More...
char *	VuoModifierKey_getString (const VuoModifierKey value)
	Automatically generated function. More...
void	VuoModifierKey_retain (VuoModifierKey value)
	Automatically generated function. More...
void	VuoModifierKey_release (VuoModifierKey value)
	Automatically generated function. More...

Enumeration Type Documentation

VuoModifierKey

enum VuoModifierKey

The available modifier keys (or any or none).

Values are stored in high 32 bits of a 64 bit unsigned int.

Definition at line 29 of file VuoModifierKey.h.

Function Documentation

VuoModifierKey_doMacEventFlagsMatch()

bool VuoModifierKey_doMacEventFlagsMatch	(	unsigned long	flags,
		VuoModifierKey	modifierKey
	)

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

Definition at line 139 of file VuoModifierKey.c.

VuoModifierKey_getAllowedValues()

VuoList_VuoModifierKey VuoModifierKey_getAllowedValues

(

void

)

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

Definition at line 92 of file VuoModifierKey.c.

VuoModifierKey_getJson()

struct json_object * VuoModifierKey_getJson

(

const VuoModifierKey

value

)

Encodes value as a JSON object.

Definition at line 61 of file VuoModifierKey.c.

VuoModifierKey_getString()

char* VuoModifierKey_getString

(

const VuoModifierKey

value

)

Automatically generated function.

VuoModifierKey_getSummary()

char * VuoModifierKey_getSummary

(

const VuoModifierKey

value

)

Returns a brief description of value.

Definition at line 108 of file VuoModifierKey.c.

VuoModifierKey_makeFromJson()

VuoModifierKey VuoModifierKey_makeFromJson

(

json_object *

js

)

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

Definition at line 32 of file VuoModifierKey.c.

VuoModifierKey_makeFromString()

VuoModifierKey VuoModifierKey_makeFromString

(

const char *

str

)

Automatically generated function.

VuoModifierKey_release()

void VuoModifierKey_release

(

VuoModifierKey

value

)

Automatically generated function.

VuoModifierKey_retain()

void VuoModifierKey_retain

(

VuoModifierKey

value

)

Automatically generated function.