Songbird / Development / Songbird Add-Ons API Documentation

sbIPropertyUnitConverter Interface Reference

Property unit converter interface This is an interface songbird property converter, used to convert a property value between its various units representations. More...

List of all members.

Public Member Functions

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.
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.

Public Attributes

readonly attribute nsISimpleEnumerator units
 The list of available units for this property.
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.
readonly attribute AString stringBundle
 The url to the string bundle used to localize partial entities.
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.


Detailed Description

Property unit converter interface This is an interface songbird property converter, used to convert a property value between its various units representations.

Definition at line 70 of file sbIPropertyUnitConverter.idl.


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:29:02 2009 for Songbird by  doxygen 1.5.2