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

Description

A list of VuoWindowProperty elements.

Classes

struct  VuoList_VuoWindowProperty_struct
 A list of VuoWindowProperty elements. More...
 

Typedefs

typedef struct
VuoList_VuoWindowProperty_struct
VuoList_VuoWindowProperty
 A list of VuoWindowProperty elements.
 

Functions

VuoList_VuoWindowProperty VuoListCreate_VuoWindowProperty (void)
 Creates a new list of VuoWindowProperty elements.
 
VuoList_VuoWindowProperty VuoListCreateWithCount_VuoWindowProperty (const unsigned long count, const VuoWindowProperty value)
 Creates a new list of count instances of value.
 
VuoList_VuoWindowProperty VuoListCopy_VuoWindowProperty (const VuoList_VuoWindowProperty list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoWindowProperty VuoListGetValue_VuoWindowProperty (const VuoList_VuoWindowProperty list, const unsigned long index)
 Returns the VuoWindowProperty at index.
 
VuoWindowPropertyVuoListGetData_VuoWindowProperty (const VuoList_VuoWindowProperty list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoWindowProperty (const VuoList_VuoWindowProperty list, const VuoWindowProperty value, const unsigned long index)
 Changes the VuoWindowProperty at index.
 
void VuoListInsertValue_VuoWindowProperty (const VuoList_VuoWindowProperty list, const VuoWindowProperty value, const unsigned long index)
 Inserts the VuoWindowProperty immediately before index.
 
void VuoListPrependValue_VuoWindowProperty (VuoList_VuoWindowProperty list, const VuoWindowProperty value)
 Prepends value to list.
 
void VuoListAppendValue_VuoWindowProperty (VuoList_VuoWindowProperty list, const VuoWindowProperty value)
 Appends value to list.
 
void VuoListExchangeValues_VuoWindowProperty (VuoList_VuoWindowProperty list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoWindowProperty (VuoList_VuoWindowProperty list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoWindowProperty (VuoList_VuoWindowProperty list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoWindowProperty (VuoList_VuoWindowProperty 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_VuoWindowProperty (VuoList_VuoWindowProperty list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoWindowProperty (VuoList_VuoWindowProperty list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoWindowProperty (VuoList_VuoWindowProperty list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoWindowProperty (VuoList_VuoWindowProperty list, const unsigned long index)
 Removes the VuoWindowProperty at index.
 
unsigned long VuoListGetCount_VuoWindowProperty (const VuoList_VuoWindowProperty list)
 Returns the number of elements in list.
 
VuoList_VuoWindowProperty VuoList_VuoWindowProperty_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoWindowProperty_getJson (const VuoList_VuoWindowProperty value)
 Encodes value as a JSON object.
 
char * VuoList_VuoWindowProperty_getSummary (const VuoList_VuoWindowProperty value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoWindowProperty VuoList_VuoWindowProperty_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoWindowProperty_getString (const VuoList_VuoWindowProperty value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoWindowProperty_struct
Class Members
void * l

Typedef Documentation

A list of VuoWindowProperty elements.

Function Documentation

struct json_object* VuoList_VuoWindowProperty_getJson ( const VuoList_VuoWindowProperty  value)
read

Encodes value as a JSON object.

char* VuoList_VuoWindowProperty_getString ( const VuoList_VuoWindowProperty  value)

Automatically generated function.

char* VuoList_VuoWindowProperty_getSummary ( const VuoList_VuoWindowProperty  value)

Produces a brief human-readable summary of value.

VuoList_VuoWindowProperty VuoList_VuoWindowProperty_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

Example:
["uno", "dos", "tres", "catorce"]
VuoList_VuoWindowProperty VuoList_VuoWindowProperty_makeFromString ( const char *  str)

Automatically generated function.

void VuoListAppendValue_VuoWindowProperty ( VuoList_VuoWindowProperty  list,
const VuoWindowProperty  value 
)

Appends value to list.

VuoList_VuoWindowProperty VuoListCopy_VuoWindowProperty ( const VuoList_VuoWindowProperty  list)

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

VuoList_VuoWindowProperty VuoListCreate_VuoWindowProperty ( void  )

Creates a new list of VuoWindowProperty elements.

VuoList_VuoWindowProperty VuoListCreateWithCount_VuoWindowProperty ( const unsigned long  count,
const VuoWindowProperty  value 
)

Creates a new list of count instances of value.

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

void VuoListCut_VuoWindowProperty ( VuoList_VuoWindowProperty  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_VuoWindowProperty ( VuoList_VuoWindowProperty  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoWindowProperty ( const VuoList_VuoWindowProperty  list)

Returns the number of elements in list.

VuoWindowProperty* VuoListGetData_VuoWindowProperty ( const VuoList_VuoWindowProperty  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.

VuoWindowProperty VuoListGetValue_VuoWindowProperty ( const VuoList_VuoWindowProperty  list,
const unsigned long  index 
)

Returns the VuoWindowProperty 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_VuoWindowProperty ( const VuoList_VuoWindowProperty  list,
const VuoWindowProperty  value,
const unsigned long  index 
)

Inserts the VuoWindowProperty 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_VuoWindowProperty ( VuoList_VuoWindowProperty  list,
const VuoWindowProperty  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoWindowProperty ( VuoList_VuoWindowProperty  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoWindowProperty ( VuoList_VuoWindowProperty  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoWindowProperty ( VuoList_VuoWindowProperty  list)

Removes the last value from list.

void VuoListRemoveValue_VuoWindowProperty ( VuoList_VuoWindowProperty  list,
const unsigned long  index 
)

Removes the VuoWindowProperty 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_VuoWindowProperty ( VuoList_VuoWindowProperty  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoWindowProperty ( const VuoList_VuoWindowProperty  list,
const VuoWindowProperty  value,
const unsigned long  index 
)

Changes the VuoWindowProperty 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_VuoWindowProperty ( VuoList_VuoWindowProperty  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.