#include <sbPropertyUnitConverter.h>

Inheritance diagram for sbPropertyUnitConverter:

Collaboration diagram for sbPropertyUnitConverter:

Classes
struct	propertyUnit

class	propertyUnitList

class	propertyUnitMap

class	propertyUnitMapInternal

Public Member Functions
NS_DECL_ISUPPORTS NS_DECL_SBIPROPERTYUNITCONVERTER	sbPropertyUnitConverter ()

virtual	~sbPropertyUnitConverter ()

Public Member Functions inherited from sbIPropertyUnitConverter
AString	convert (in AString aValue, in AString aFromUnitID, in AString aToUnitID, in long aMinDecimals, in long aMaxDecimals)
	Convert a value to a different unit. Use -1 for aMinDecimals and aMaxDecimals if you do not wish to set any limits on the number of decimals in the returned value. More...

AString	autoFormat (in AString aValue, in long aMinDecimals, in long aMaxDecimals)
	Formats a value using the most suitable unit. Use -1 for aMinDecimals and aMaxDecimals if you do not wish to set any limits on the number of decimals in the returned value. More...

Protected Member Functions
void	RegisterUnit (PRUint32 aUnitInternalID, const nsAString &aUnitExternalID, const nsAString &aUnitName, const nsAString &aUnitShortName, PRBool isNative=PR_FALSE)

void	SetStringBundle (const nsAString &aStringBundle)

NS_IMETHOD	ConvertFromNativeToUnit (PRFloat64 aValue, PRUint32 aUnitID, PRFloat64 &_retVal)=0

NS_IMETHOD	ConvertFromUnitToNative (PRFloat64 aValue, PRUint32 aUnitID, PRFloat64 &_retVal)=0

virtual PRInt32	GetAutoUnit (PRFloat64 aValue)

nsresult	PerformConversion (PRFloat64 &aValue, PRUint32 aFromUnit, PRUint32 aToUnit)

void	RemoveTrailingZeroes (nsAString &aValue)

void	LimitToNDecimals (nsAString &aValue, PRUint32 aDecimals)

void	ForceToNDecimals (nsAString &aValue, PRUint32 aDecimals)

void	ApplyDecimalLimits (nsAString &aValue, PRInt32 aMinDecimals, PRInt32 aMaxDecimals)

nsresult	SscanfFloat64 (const nsAString &aValue, PRFloat64 &aOutValue)

nsresult	SprintfFloat64 (const PRFloat64 aValue, nsAString &aOutValue)

Protected Attributes
PRLock *	mLock

nsString	mNative

PRUint32	mNativeInternal

nsString	mStringBundle

nsCOMPtr< nsIStringBundleService >	mStringBundleService

nsCOMPtr< nsIStringBundle >	mStringBundleObject

propertyUnitMap	mUnitsMap

propertyUnitMapInternal	mUnitsMapInternal

propertyUnitList	mUnits

PRUnichar	mDecimalPoint

nsCOMPtr< nsIWeakReference >	mPropertyInfo

Additional Inherited Members
Public Attributes inherited from sbIPropertyUnitConverter
readonly attribute nsISimpleEnumerator	units
	The list of available units for this property. More...

readonly attribute AString	nativeUnitId
	The native unit for this property. This is the unit used for storage in the database, and that is implied when getting and setting the property. More...

readonly attribute AString	stringBundle
	The url to the string bundle used to localize partial entities. More...

attribute sbIPropertyInfo	propertyInfo
	The sbIPropertyInfo this converter is associated with. This attribute will be set automatically by the propertyinfo object when its converter is assigned. More...

Detailed Description

Definition at line 67 of file sbPropertyUnitConverter.h.

Constructor & Destructor Documentation

sbPropertyUnitConverter::sbPropertyUnitConverter ( )

Definition at line 151 of file sbPropertyUnitConverter.cpp.

Here is the call graph for this function:

sbPropertyUnitConverter::~sbPropertyUnitConverter ( )

virtual

Definition at line 163 of file sbPropertyUnitConverter.cpp.

Member Function Documentation

void sbPropertyUnitConverter::ApplyDecimalLimits	(	nsAString &	aValue,
		PRInt32	aMinDecimals,
		PRInt32	aMaxDecimals
	)

protected

Definition at line 326 of file sbPropertyUnitConverter.cpp.

Here is the call graph for this function:

NS_IMETHOD sbPropertyUnitConverter::ConvertFromNativeToUnit	(	PRFloat64	aValue,
		PRUint32	aUnitID,
		PRFloat64 &	_retVal
	)

protectedpure virtual

Implemented in sbDurationPropertyUnitConverter, sbStoragePropertyUnitConverter, sbBitratePropertyUnitConverter, and sbFrequencyPropertyUnitConverter.

Here is the caller graph for this function:

NS_IMETHOD sbPropertyUnitConverter::ConvertFromUnitToNative	(	PRFloat64	aValue,
		PRUint32	aUnitID,
		PRFloat64 &	_retVal
	)

protectedpure virtual

Implemented in sbDurationPropertyUnitConverter, sbStoragePropertyUnitConverter, sbFrequencyPropertyUnitConverter, and sbBitratePropertyUnitConverter.

Here is the caller graph for this function:

void sbPropertyUnitConverter::ForceToNDecimals	(	nsAString &	aValue,
		PRUint32	aDecimals
	)

protected

Definition at line 310 of file sbPropertyUnitConverter.cpp.

Here is the caller graph for this function:

virtual PRInt32 sbPropertyUnitConverter::GetAutoUnit ( PRFloat64 aValue )

inlineprotectedvirtual

Reimplemented in sbStoragePropertyUnitConverter, sbBitratePropertyUnitConverter, and sbFrequencyPropertyUnitConverter.

Definition at line 92 of file sbPropertyUnitConverter.h.

void sbPropertyUnitConverter::LimitToNDecimals	(	nsAString &	aValue,
		PRUint32	aDecimals
	)

protected

Definition at line 298 of file sbPropertyUnitConverter.cpp.

Here is the caller graph for this function:

nsresult sbPropertyUnitConverter::PerformConversion	(	PRFloat64 &	aValue,
		PRUint32	aFromUnit,
		PRUint32	aToUnit
	)

protected

Definition at line 220 of file sbPropertyUnitConverter.cpp.

Here is the call graph for this function:

void sbPropertyUnitConverter::RegisterUnit	(	PRUint32	aUnitInternalID,
		const nsAString &	aUnitExternalID,
		const nsAString &	aUnitName,
		const nsAString &	aUnitShortName,
		PRBool	isNative = `PR_FALSE`
	)

protected

Definition at line 173 of file sbPropertyUnitConverter.cpp.

Here is the caller graph for this function:

void sbPropertyUnitConverter::RemoveTrailingZeroes ( nsAString & aValue )

protected

Definition at line 287 of file sbPropertyUnitConverter.cpp.

Here is the caller graph for this function:

void sbPropertyUnitConverter::SetStringBundle ( const nsAString & aStringBundle )

protected

Definition at line 378 of file sbPropertyUnitConverter.cpp.

Here is the caller graph for this function:

nsresult sbPropertyUnitConverter::SprintfFloat64	(	const PRFloat64	aValue,
		nsAString &	aOutValue
	)

protected

Definition at line 207 of file sbPropertyUnitConverter.cpp.

nsresult sbPropertyUnitConverter::SscanfFloat64	(	const nsAString &	aValue,
		PRFloat64 &	aOutValue
	)

protected

Definition at line 195 of file sbPropertyUnitConverter.cpp.

Member Data Documentation

PRUnichar sbPropertyUnitConverter::mDecimalPoint

protected

Definition at line 123 of file sbPropertyUnitConverter.h.

PRLock* sbPropertyUnitConverter::mLock

protected

Definition at line 104 of file sbPropertyUnitConverter.h.

nsString sbPropertyUnitConverter::mNative

protected

Definition at line 105 of file sbPropertyUnitConverter.h.

PRUint32 sbPropertyUnitConverter::mNativeInternal

protected

Definition at line 106 of file sbPropertyUnitConverter.h.

nsCOMPtr<nsIWeakReference> sbPropertyUnitConverter::mPropertyInfo

protected

Definition at line 125 of file sbPropertyUnitConverter.h.

nsString sbPropertyUnitConverter::mStringBundle

protected

Definition at line 107 of file sbPropertyUnitConverter.h.

nsCOMPtr<nsIStringBundle> sbPropertyUnitConverter::mStringBundleObject

protected

Definition at line 109 of file sbPropertyUnitConverter.h.

nsCOMPtr<nsIStringBundleService> sbPropertyUnitConverter::mStringBundleService

protected

Definition at line 108 of file sbPropertyUnitConverter.h.

propertyUnitList sbPropertyUnitConverter::mUnits

protected

Definition at line 121 of file sbPropertyUnitConverter.h.

propertyUnitMap sbPropertyUnitConverter::mUnitsMap

protected

Definition at line 119 of file sbPropertyUnitConverter.h.

propertyUnitMapInternal sbPropertyUnitConverter::mUnitsMapInternal

protected

Definition at line 120 of file sbPropertyUnitConverter.h.

The documentation for this class was generated from the following files:

/home/martin/dev/nightingale-hacking/components/property/src/sbPropertyUnitConverter.h
/home/martin/dev/nightingale-hacking/components/property/src/sbPropertyUnitConverter.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation