VuoList_VuoDragEvent

Description

A list of VuoDragEvent elements.

Classes
struct	VuoList_VuoDragEvent_struct
	A list of VuoDragEvent elements. More...

Typedefs
typedef struct VuoList_VuoDragEvent_struct *	VuoList_VuoDragEvent
	A list of VuoDragEvent elements.

Functions
VuoList_VuoDragEvent	VuoListCreate_VuoDragEvent (void)
	Creates a new list of VuoDragEvent elements.
VuoList_VuoDragEvent	VuoListCreateWithCount_VuoDragEvent (const unsigned long count, const VuoDragEvent value)
	Creates a new list of count instances of value.
VuoList_VuoDragEvent	VuoListCopy_VuoDragEvent (const VuoList_VuoDragEvent list)
	Makes a shallow copy of list — its items are retained (not copied) by the new list.
VuoDragEvent	VuoListGetValue_VuoDragEvent (const VuoList_VuoDragEvent list, const unsigned long index)
	Returns the VuoDragEvent at index.
VuoDragEvent *	VuoListGetData_VuoDragEvent (const VuoList_VuoDragEvent list)
	Returns a pointer to a C array containing the list items.
void	VuoListSetValue_VuoDragEvent (const VuoList_VuoDragEvent list, const VuoDragEvent value, const unsigned long index)
	Changes the VuoDragEvent at index.
void	VuoListInsertValue_VuoDragEvent (const VuoList_VuoDragEvent list, const VuoDragEvent value, const unsigned long index)
	Inserts the VuoDragEvent immediately before index.
void	VuoListPrependValue_VuoDragEvent (VuoList_VuoDragEvent list, const VuoDragEvent value)
	Prepends value to list.
void	VuoListAppendValue_VuoDragEvent (VuoList_VuoDragEvent list, const VuoDragEvent value)
	Appends value to list.
void	VuoListExchangeValues_VuoDragEvent (VuoList_VuoDragEvent list, const unsigned long indexA, const unsigned long indexB)
	Swaps the value at indexA with the value at indexB.
void	VuoListShuffle_VuoDragEvent (VuoList_VuoDragEvent list, const double chaos)
	Generates a random permutation of list.
void	VuoListReverse_VuoDragEvent (VuoList_VuoDragEvent list)
	Reverses the order of the items in list.
void	VuoListCut_VuoDragEvent (VuoList_VuoDragEvent list, const signed long startIndex, const unsigned long itemCount)
	Removes items from the list except those in the range specified by startIndex and itemCount.
void	VuoListRemoveFirstValue_VuoDragEvent (VuoList_VuoDragEvent list)
	Removes the first value from list.
void	VuoListRemoveLastValue_VuoDragEvent (VuoList_VuoDragEvent list)
	Removes the last value from list.
void	VuoListRemoveAll_VuoDragEvent (VuoList_VuoDragEvent list)
	Removes all values from list.
void	VuoListRemoveValue_VuoDragEvent (VuoList_VuoDragEvent list, const unsigned long index)
	Removes the VuoDragEvent at index.
unsigned long	VuoListGetCount_VuoDragEvent (const VuoList_VuoDragEvent list)
	Returns the number of elements in list.
VuoList_VuoDragEvent	VuoList_VuoDragEvent_makeFromJson (struct json_object *js)
	Decodes the JSON object js to create a new value.
struct json_object *	VuoList_VuoDragEvent_getJson (const VuoList_VuoDragEvent value)
	Encodes value as a JSON object.
char *	VuoList_VuoDragEvent_getSummary (const VuoList_VuoDragEvent value)
	Produces a brief human-readable summary of value.
VuoList_VuoDragEvent	VuoList_VuoDragEvent_makeFromString (const char *str)
	Automatically generated function.
char *	VuoList_VuoDragEvent_getString (const VuoList_VuoDragEvent value)
	Automatically generated function.

---

Class Documentation

struct VuoList_VuoDragEvent_struct

Class Members
void *	l

Typedef Documentation

typedef struct VuoList_VuoDragEvent_struct * VuoList_VuoDragEvent

A list of VuoDragEvent elements.

Function Documentation

struct json_object* VuoList_VuoDragEvent_getJson ( const VuoList_VuoDragEvent  value )

read

Encodes value as a JSON object.

char* VuoList_VuoDragEvent_getString

(

const VuoList_VuoDragEvent

value

)

Automatically generated function.

char* VuoList_VuoDragEvent_getSummary

(

const VuoList_VuoDragEvent

value

)

Produces a brief human-readable summary of value.

VuoList_VuoDragEvent VuoList_VuoDragEvent_makeFromJson

(

struct json_object *

js

)

Decodes the JSON object js to create a new value.

Example:

["uno", "dos", "tres", "catorce"]

VuoList_VuoDragEvent VuoList_VuoDragEvent_makeFromString

(

const char *

str

)

Automatically generated function.

void VuoListAppendValue_VuoDragEvent	(	VuoList_VuoDragEvent	list,
		const VuoDragEvent	value
	)

Appends value to list.

VuoList_VuoDragEvent VuoListCopy_VuoDragEvent

(

const VuoList_VuoDragEvent

list

)

Makes a shallow copy of list — its items are retained (not copied) by the new list.

VuoList_VuoDragEvent VuoListCreate_VuoDragEvent

(

void

)

Creates a new list of VuoDragEvent elements.

VuoList_VuoDragEvent VuoListCreateWithCount_VuoDragEvent	(	const unsigned long	count,
		const VuoDragEvent	value
	)

Creates a new list of count instances of value.

Use this in conjunction with VuoListGetData_VuoDragEvent to quickly initialize a large list.

void VuoListCut_VuoDragEvent	(	VuoList_VuoDragEvent	list,
		const signed long	startIndex,
		const unsigned long	itemCount
	)

Removes items from the list except those in the range specified by startIndex and itemCount.

void VuoListExchangeValues_VuoDragEvent	(	VuoList_VuoDragEvent	list,
		const unsigned long	indexA,
		const unsigned long	indexB
	)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoDragEvent

(

const VuoList_VuoDragEvent

list

)

Returns the number of elements in list.

VuoDragEvent* VuoListGetData_VuoDragEvent

(

const VuoList_VuoDragEvent

list

)

Returns a pointer to a C array containing the list items.

Use this if you need a fast way to get or change multiple list items.

You can modify values in the list by changing them in this array. Just don't attempt to access beyond the list size.

The pointer becomes invalid if you modify the list size using other functions (e.g., Insert, Prepend, Append, Cut, Remove); if you use those functions, just get a new pointer by calling this function again.

If the list has no items, returns NULL.

The pointer remains owned by the list; don't free it.

VuoDragEvent VuoListGetValue_VuoDragEvent	(	const VuoList_VuoDragEvent	list,
		const unsigned long	index
	)

Returns the VuoDragEvent at index.

Index values start at 1. If the list has no items, returns a default value. Attempting to access an out-of-bounds index returns the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).

void VuoListInsertValue_VuoDragEvent	(	const VuoList_VuoDragEvent	list,
		const VuoDragEvent	value,
		const unsigned long	index
	)

Inserts the VuoDragEvent immediately before index.

Index values start at 1. Inserting at index 0 prepends the value to the list. Inserting at an index beyond the last value in the list appends the value to the list.

void VuoListPrependValue_VuoDragEvent	(	VuoList_VuoDragEvent	list,
		const VuoDragEvent	value
	)

Prepends value to list.

void VuoListRemoveAll_VuoDragEvent

(

VuoList_VuoDragEvent

list

)

Removes all values from list.

void VuoListRemoveFirstValue_VuoDragEvent

(

VuoList_VuoDragEvent

list

)

Removes the first value from list.

void VuoListRemoveLastValue_VuoDragEvent

(

VuoList_VuoDragEvent

list

)

Removes the last value from list.

void VuoListRemoveValue_VuoDragEvent	(	VuoList_VuoDragEvent	list,
		const unsigned long	index
	)

Removes the VuoDragEvent at index.

Index values start at 1. Attempting to remove index 0 or an index beyond the last value in the list has no effect.

void VuoListReverse_VuoDragEvent

(

VuoList_VuoDragEvent

list

)

Reverses the order of the items in list.

void VuoListSetValue_VuoDragEvent	(	const VuoList_VuoDragEvent	list,
		const VuoDragEvent	value,
		const unsigned long	index
	)

Changes the VuoDragEvent at index.

Index values start at 1. If the list has no items, nothing is changed. Attempting to change an out-of-bounds index changes the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).

void VuoListShuffle_VuoDragEvent	(	VuoList_VuoDragEvent	list,
		const double	chaos
	)

Generates a random permutation of list.

chaos ranges from 0 to 1. When chaos is 1, a full Fisher–Yates shuffle is performed. When less than 1, fewer iterations are performed.