Vuo  2.3.2
Macros | Enumerations | Functions
VuoNumberFormat

Description

How to convert a number into text.

Enumerations

enum  VuoNumberFormat { VuoNumberFormat_Decimal , VuoNumberFormat_Percentage , VuoNumberFormat_Currency }
 How to convert a number into text. More...
 

Functions

VuoNumberFormat VuoNumberFormat_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoNumberFormat_getJson (const VuoNumberFormat value)
 Encodes value as a JSON object. More...
 
VuoList_VuoNumberFormat VuoNumberFormat_getAllowedValues (void)
 Returns a list of values that instances of this type can have. More...
 
char * VuoNumberFormat_getSummary (const VuoNumberFormat value)
 Returns a compact string representation of value. More...
 
VuoText VuoNumberFormat_format (VuoReal value, VuoNumberFormat format, VuoInteger minimumIntegerDigits, VuoInteger minimumDecimalPlaces, VuoInteger decimalPlaces, bool showThousandSeparator)
 Returns a new VuoText string from the formatted number value. More...
 
bool VuoNumberFormat_areEqual (const VuoNumberFormat valueA, const VuoNumberFormat valueB)
 Returns true if the two values are equal. More...
 
bool VuoNumberFormat_isLessThan (const VuoNumberFormat valueA, const VuoNumberFormat valueB)
 Returns true if valueA is less than valueB. More...
 
VuoNumberFormat VuoNumberFormat_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoNumberFormat_getString (const VuoNumberFormat value)
 Automatically generated function. More...
 
void VuoNumberFormat_retain (VuoNumberFormat value)
 Automatically generated function. More...
 
void VuoNumberFormat_release (VuoNumberFormat value)
 Automatically generated function. More...
 

Enumeration Type Documentation

◆ VuoNumberFormat

How to convert a number into text.

Definition at line 30 of file VuoNumberFormat.h.

Function Documentation

◆ VuoNumberFormat_areEqual()

bool VuoNumberFormat_areEqual ( const VuoNumberFormat  valueA,
const VuoNumberFormat  valueB 
)

Returns true if the two values are equal.

Definition at line 153 of file VuoNumberFormat.c.

◆ VuoNumberFormat_format()

VuoText VuoNumberFormat_format ( VuoReal  value,
VuoNumberFormat  format,
VuoInteger  minimumIntegerDigits,
VuoInteger  minimumDecimalPlaces,
VuoInteger  decimalPlaces,
bool  showThousandSeparator 
)

Returns a new VuoText string from the formatted number value.

Changed in Vuo 2.0.0:
New.

Definition at line 72 of file VuoNumberFormat.c.

◆ VuoNumberFormat_getAllowedValues()

VuoList_VuoNumberFormat VuoNumberFormat_getAllowedValues ( void  )

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

Definition at line 126 of file VuoNumberFormat.c.

◆ VuoNumberFormat_getJson()

struct json_object* VuoNumberFormat_getJson ( const VuoNumberFormat  value)

Encodes value as a JSON object.

Definition at line 56 of file VuoNumberFormat.c.

◆ VuoNumberFormat_getString()

char* VuoNumberFormat_getString ( const VuoNumberFormat  value)

Automatically generated function.

◆ VuoNumberFormat_getSummary()

char* VuoNumberFormat_getSummary ( const VuoNumberFormat  value)

Returns a compact string representation of value.

Definition at line 138 of file VuoNumberFormat.c.

◆ VuoNumberFormat_isLessThan()

bool VuoNumberFormat_isLessThan ( const VuoNumberFormat  valueA,
const VuoNumberFormat  valueB 
)

Returns true if valueA is less than valueB.

Definition at line 161 of file VuoNumberFormat.c.

◆ VuoNumberFormat_makeFromJson()

VuoNumberFormat VuoNumberFormat_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
"percentage"

Definition at line 37 of file VuoNumberFormat.c.

◆ VuoNumberFormat_makeFromString()

VuoNumberFormat VuoNumberFormat_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoNumberFormat_release()

void VuoNumberFormat_release ( VuoNumberFormat  value)

Automatically generated function.

◆ VuoNumberFormat_retain()

void VuoNumberFormat_retain ( VuoNumberFormat  value)

Automatically generated function.