Songbird / Development / Songbird Add-Ons API Documentation

components/property/public/sbIPropertyUnitConverter.idl

00001 /*
00002 //
00003 // BEGIN SONGBIRD GPL
00004 // 
00005 // This file is part of the Songbird web player.
00006 //
00007 // Copyright(c) 2005-2008 POTI, Inc.
00008 // http://songbirdnest.com
00009 // 
00010 // This file may be licensed under the terms of of the
00011 // GNU General Public License Version 2 (the "GPL").
00012 // 
00013 // Software distributed under the License is distributed 
00014 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either 
00015 // express or implied. See the GPL for the specific language 
00016 // governing rights and limitations.
00017 //
00018 // You should have received a copy of the GPL along with this 
00019 // program. If not, go to http://www.gnu.org/licenses/gpl.html
00020 // or write to the Free Software Foundation, Inc., 
00021 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00022 // 
00023 // END SONGBIRD GPL
00024 //
00025  */
00026 
00027 #include "nsISupports.idl"
00028 
00029 interface nsISimpleEnumerator;
00030 interface sbIPropertyInfo;
00031 
00037 [scriptable, uuid(7b86a6fc-a9d4-4ef9-90e3-3334e58cc3d6)]
00038 interface sbIPropertyUnit : nsISupports
00039 {
00046   readonly attribute AString id;
00047   
00053   readonly attribute AString name;
00054 
00060   readonly attribute AString shortName;
00061 };
00062 
00069 [scriptable, uuid(16814f07-373a-404a-a31b-73ca83cb3c96)]
00070 interface sbIPropertyUnitConverter : nsISupports
00071 {
00077   AString convert(in AString aValue, 
00078                   in AString aFromUnitID, 
00079                   in AString aToUnitID,
00080                   in long aMinDecimals,
00081                   in long aMaxDecimals);
00082   
00086   readonly attribute nsISimpleEnumerator units;
00087   
00093   readonly attribute AString nativeUnitId;
00094   
00098   readonly attribute AString stringBundle;
00099   
00105   AString autoFormat(in AString aValue,
00106                      in long aMinDecimals,
00107                      in long aMaxDecimals);
00108   
00114   attribute sbIPropertyInfo propertyInfo;
00115 };

Generated on Tue Mar 10 14:28:55 2009 for Songbird by  doxygen 1.5.2