Songbird / Development / Songbird Add-Ons API Documentation

components/bundle/public/sbIBundle.idl

Go to the documentation of this file.
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 
00037 interface sbIBundleDataListener;
00038 interface sbIBundleInstallListener;
00039 interface nsIDOMDocument;
00040 interface nsIDOMWindow;
00049 [scriptable, uuid(656eda3e-aeff-11db-96e1-005056c00008)]
00050 interface sbIBundle : nsISupports
00051 {
00058   attribute AString bundleId;
00059 
00066   attribute AString bundleURL;
00067 
00075   void retrieveBundleData(in long aTimeout);
00076 
00080   void retrieveLocalBundleData();
00081 
00089   void addBundleDataListener(in sbIBundleDataListener aListener);
00090 
00097   void removeBundleDataListener(in sbIBundleDataListener aListener);
00098 
00106   readonly attribute long bundleDataStatus;
00107   const long BUNDLE_DATA_STATUS_ERROR       = -1;
00108   const long BUNDLE_DATA_STATUS_DOWNLOADING = 0;
00109   const long BUNDLE_DATA_STATUS_SUCCESS     = 1;
00110 
00115   readonly attribute nsIDOMDocument bundleDataDocument;
00116 
00121   readonly attribute AString bundleDataText;
00122 
00127   readonly attribute AString bundleDataVersion;
00128   
00133   readonly attribute long bundleExtensionCount; 
00134 
00139   void removeExtension(in long aIndex);
00140 
00149   AString getExtensionAttribute(in long aIndex, in AString aAttributeName);
00150 
00160   boolean getExtensionInstallFlag(in long aIndex);
00161   
00168   void setExtensionInstallFlag(in long aIndex, in boolean aInstallFlag);
00169   
00176   void addBundleInstallListener(in sbIBundleInstallListener aListener);
00177 
00184   void removeBundleInstallListener(in sbIBundleInstallListener aListener);
00185 
00198   long installFlaggedExtensions(in nsIDOMWindow aWindow);
00199   const long BUNDLE_INSTALL_ERROR = 0;
00200   const long BUNDLE_INSTALL_SUCCESS = 1;
00201 
00208   readonly attribute boolean restartRequired;
00209 };
00210 
00211 

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