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

Description

A list of VuoText elements.

Classes

struct  VuoList_VuoText_struct
 A list of VuoText elements. More...
 

Typedefs

typedef struct
VuoList_VuoText_struct
VuoList_VuoText
 A list of VuoText elements.
 

Functions

VuoList_VuoText VuoListCreate_VuoText (void)
 Creates a new list of VuoText elements.
 
VuoList_VuoText VuoListCreateWithCount_VuoText (const unsigned long count, const VuoText value)
 Creates a new list of count instances of value.
 
VuoList_VuoText VuoListCopy_VuoText (const VuoList_VuoText list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoText VuoListGetValue_VuoText (const VuoList_VuoText list, const unsigned long index)
 Returns the VuoText at index.
 
VuoTextVuoListGetData_VuoText (const VuoList_VuoText list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoText (const VuoList_VuoText list, const VuoText value, const unsigned long index)
 Changes the VuoText at index.
 
void VuoListInsertValue_VuoText (const VuoList_VuoText list, const VuoText value, const unsigned long index)
 Inserts the VuoText immediately before index.
 
void VuoListPrependValue_VuoText (VuoList_VuoText list, const VuoText value)
 Prepends value to list.
 
void VuoListAppendValue_VuoText (VuoList_VuoText list, const VuoText value)
 Appends value to list.
 
void VuoListExchangeValues_VuoText (VuoList_VuoText list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoText (VuoList_VuoText list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoText (VuoList_VuoText list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoText (VuoList_VuoText 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_VuoText (VuoList_VuoText list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoText (VuoList_VuoText list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoText (VuoList_VuoText list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoText (VuoList_VuoText list, const unsigned long index)
 Removes the VuoText at index.
 
unsigned long VuoListGetCount_VuoText (const VuoList_VuoText list)
 Returns the number of elements in list.
 
VuoList_VuoText VuoList_VuoText_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoText_getJson (const VuoList_VuoText value)
 Encodes value as a JSON object.
 
char * VuoList_VuoText_getSummary (const VuoList_VuoText value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoText VuoList_VuoText_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoText_getString (const VuoList_VuoText value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoText_struct
Class Members
void * l

Typedef Documentation

A list of VuoText elements.

Function Documentation

struct json_object* VuoList_VuoText_getJson ( const VuoList_VuoText  value)
read

Encodes value as a JSON object.

char* VuoList_VuoText_getString ( const VuoList_VuoText  value)

Automatically generated function.

char* VuoList_VuoText_getSummary ( const VuoList_VuoText  value)

Produces a brief human-readable summary of value.

VuoList_VuoText VuoList_VuoText_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

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

Automatically generated function.

void VuoListAppendValue_VuoText ( VuoList_VuoText  list,
const VuoText  value 
)

Appends value to list.

VuoList_VuoText VuoListCopy_VuoText ( const VuoList_VuoText  list)

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

VuoList_VuoText VuoListCreate_VuoText ( void  )

Creates a new list of VuoText elements.

VuoList_VuoText VuoListCreateWithCount_VuoText ( const unsigned long  count,
const VuoText  value 
)

Creates a new list of count instances of value.

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

void VuoListCut_VuoText ( VuoList_VuoText  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_VuoText ( VuoList_VuoText  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoText ( const VuoList_VuoText  list)

Returns the number of elements in list.

VuoText* VuoListGetData_VuoText ( const VuoList_VuoText  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.

VuoText VuoListGetValue_VuoText ( const VuoList_VuoText  list,
const unsigned long  index 
)

Returns the VuoText 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_VuoText ( const VuoList_VuoText  list,
const VuoText  value,
const unsigned long  index 
)

Inserts the VuoText 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_VuoText ( VuoList_VuoText  list,
const VuoText  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoText ( VuoList_VuoText  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoText ( VuoList_VuoText  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoText ( VuoList_VuoText  list)

Removes the last value from list.

void VuoListRemoveValue_VuoText ( VuoList_VuoText  list,
const unsigned long  index 
)

Removes the VuoText 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_VuoText ( VuoList_VuoText  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoText ( const VuoList_VuoText  list,
const VuoText  value,
const unsigned long  index 
)

Changes the VuoText 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_VuoText ( VuoList_VuoText  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.