Rules used to format displayed values for fields. More...

#include <TBFormat.qo.h>

Public Member Functions
	TBFormat ()
	Default Constructor.
	~TBFormat ()
QFontColor *	getAllFont ()
	Returns the QFontColor that is applied to all values (i.e., regardless of negative or positive etc.).
void	setAllFont (QFontColor *fc)
	Sets the QFontColor to be used on all values.
vector< QFontColor * > *	getFonts ()
	Returns the QFontColors used for different values; the order depends on the type.
void	setFonts (vector< QFontColor * > *f)
	Sets the value-dependent QFontColors to the values in the given vector.
void	addFont (QFontColor *fc)
	Adds a font to the end of the value-dependent QFontColor vector.
String	getDateFormat ()
	Returns the date format if this format applies to a date, a blank string otherwise.
void	setDateFormat (String d)
	Sets the date format for this format.
BooleanFormat	getBoolFormat ()
	Returns the boolean format.
void	setBoolFormat (BooleanFormat f)
	Sets the boolean format.
bool	getScientificFormat ()
	Returns true if this format's scientific format is on, false otherwise.
void	setScientificFormat (bool sf)
	Sets the scientific format flag.
int	getDecimalPlaces ()
	Returns the number of decimal places for this format.
void	setDecimalPlaces (int dp)
	Sets the number of decimal places for this format.
int	getVectorThreshold ()
	Returns the vector threshold for this format.
void	setVectorThreshold (int v)
	Sets the vector threshold of this format.
void	applyTo (QTableWidgetItem item, TBData data)
	Applies this format to the display value in the given QTableWidgetItem.
Private Attributes
QFontColor *	allFont
	The QFontColor to apply to all values, or NULL if there are value-dependent QFontColors.
vector< QFontColor * >	fonts
	The vector of value-dependent QFontColors (can be empty).
int	decimalPlaces
	The number of decimal places to display, or -1 for unlimited.
bool	scientificFormat
	Whether scientific format should be used.
BooleanFormat	boolFormat
	The format for boolean values.
String	dateFormat
	The format for displaying dates.
int	vectorThreshold
	The vector threshold, or -1 for unlimited.

Detailed Description

Rules used to format displayed values for fields.

Synopsis

A TBFormat contains all information necessary to format a displayed value. A format consists of different options depending on the type of the value being formatted. For example, an integer value could be in scientific notation and could have a different font style for negative and positive numbers. Generally speaking, a format has two parts: type-specific options such as scientific notation or date format, and font options. Some types may have multiple font options (i.e., one for negative values and one for non-negative values).

Definition at line 82 of file TBFormat.qo.h.

Constructor & Destructor Documentation

casa::TBFormat::TBFormat ( )

Default Constructor.

casa::TBFormat::~TBFormat ( )

Member Function Documentation

void casa::TBFormat::addFont ( QFontColor * fc )

Adds a font to the end of the value-dependent QFontColor vector.

void casa::TBFormat::applyTo	(	QTableWidgetItem *	item,
		TBData *	data
	)

Applies this format to the display value in the given QTableWidgetItem.

The pre-format data and the type must also be provided.

QFontColor* casa::TBFormat::getAllFont ( )

Returns the QFontColor that is applied to all values (i.e., regardless of negative or positive etc.).

If this format has value-dependent QFontColors, this will return NULL.

BooleanFormat casa::TBFormat::getBoolFormat ( )

Returns the boolean format.

If this format is not for a boolean value, this operation is undefined.

String casa::TBFormat::getDateFormat ( )

Returns the date format if this format applies to a date, a blank string otherwise.

See TBConstants::dateFormatIsValid().

int casa::TBFormat::getDecimalPlaces ( )

Returns the number of decimal places for this format.

If there is an unlimited number of decimal places, or this format doesn't apply to decimals, -1 is returned.

vector<QFontColor*>* casa::TBFormat::getFonts ( )

Returns the QFontColors used for different values; the order depends on the type.

For example, for a format applied to integers the non-negative QFontColor is first. If there is a format for all values, this will return an empty vector.

bool casa::TBFormat::getScientificFormat ( )

Returns true if this format's scientific format is on, false otherwise.

int casa::TBFormat::getVectorThreshold ( )

Returns the vector threshold for this format.

A vector threshold, when applied to one-dimensional arrays, will "hide" the values in the array and display the shape instead IF the size is greater than the specified threshold. If the threshold is unlimited, or this format does not apply to array types, -1 is returned.

void casa::TBFormat::setAllFont ( QFontColor * fc )

Sets the QFontColor to be used on all values.

void casa::TBFormat::setBoolFormat ( BooleanFormat f )

Sets the boolean format.

void casa::TBFormat::setDateFormat ( String d )

Sets the date format for this format.

See TBConstants::dateFormatIsValid().

void casa::TBFormat::setDecimalPlaces ( int dp )

Sets the number of decimal places for this format.

void casa::TBFormat::setFonts ( vector< QFontColor * > * f )

Sets the value-dependent QFontColors to the values in the given vector.

void casa::TBFormat::setScientificFormat ( bool sf )