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.
struct json_object *	VuoNumberFormat_getJson (const VuoNumberFormat value)
	Encodes value as a JSON object.
VuoList_VuoNumberFormat	VuoNumberFormat_getAllowedValues (void)
	Returns a list of values that instances of this type can have.
char *	VuoNumberFormat_getSummary (const VuoNumberFormat value)
	Returns a compact string representation of value.
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.
bool	VuoNumberFormat_areEqual (const VuoNumberFormat valueA, const VuoNumberFormat valueB)
	Returns true if the two values are equal.
bool	VuoNumberFormat_isLessThan (const VuoNumberFormat valueA, const VuoNumberFormat valueB)
	Returns true if valueA is less than valueB.
char *	VuoNumberFormat_getString (const VuoNumberFormat value)
	Automatically generated function.
void	VuoNumberFormat_retain (VuoNumberFormat value)
	Automatically generated function.
void	VuoNumberFormat_release (VuoNumberFormat value)
	Automatically generated function.

Macro Definition Documentation

VuoNumberFormat_SUPPORTS_COMPARISON

#define VuoNumberFormat_SUPPORTS_COMPARISON

Definition at line 37 of file VuoNumberFormat.h.

Enumeration Type Documentation

VuoNumberFormat

enum 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 151 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 70 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 124 of file VuoNumberFormat.c.

VuoNumberFormat_getJson()

struct json_object * VuoNumberFormat_getJson

(

const VuoNumberFormat

value

)

Encodes value as a JSON object.

Definition at line 54 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 136 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 159 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 35 of file VuoNumberFormat.c.

VuoNumberFormat_release()

void VuoNumberFormat_release

(

VuoNumberFormat

value

)

Automatically generated function.

VuoNumberFormat_retain()

void VuoNumberFormat_retain

(

VuoNumberFormat

value

)

Automatically generated function.