Songbird / Development / Songbird Add-Ons API Documentation

components/moz/filedownloader/public/sbIFileDownloader.idl

00001 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* vim: set sw=2 :miv */
00003 /*
00004 //
00005 // BEGIN SONGBIRD GPL
00006 //
00007 // This file is part of the Songbird web player.
00008 //
00009 // Copyright(c) 2005-2008 POTI, Inc.
00010 // http://songbirdnest.com
00011 //
00012 // This file may be licensed under the terms of of the
00013 // GNU General Public License Version 2 (the "GPL").
00014 //
00015 // Software distributed under the License is distributed
00016 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
00017 // express or implied. See the GPL for the specific language
00018 // governing rights and limitations.
00019 //
00020 // You should have received a copy of the GPL along with this
00021 // program. If not, go to http://www.gnu.org/licenses/gpl.html
00022 // or write to the Free Software Foundation, Inc.,
00023 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00024 //
00025 // END SONGBIRD GPL
00026 //
00027 */
00028 
00029 #include "nsISupports.idl"
00030 
00040 interface nsIFile;
00041 interface nsIURI;
00042 interface sbIFileDownloaderListener;
00043 
00044 [scriptable, uuid(743a7901-baec-4da3-ad92-08ba975effd5)]
00045 interface sbIFileDownloader : nsISupports
00046 {
00051   readonly attribute unsigned long long bytesToDownload;
00052 
00053 
00058   readonly attribute unsigned long long bytesDownloaded;
00059 
00060 
00065   readonly attribute unsigned long percentComplete;
00066 
00067 
00072   readonly attribute boolean complete;
00073 
00074 
00080   readonly attribute boolean succeeded;
00081 
00082 
00087   attribute sbIFileDownloaderListener listener;
00088 
00089 
00094   attribute nsIURI sourceURI;
00095 
00096 
00101   attribute AString sourceURISpec;
00102 
00103 
00109   attribute nsIFile destinationFile;
00110 
00111 
00117   attribute AString destinationFileExtension;
00118 
00119 
00126   void start();
00127 
00128 
00133   void cancel();
00134 };
00135 
00136 
00143 [scriptable, uuid(3267334a-a1ef-4bf3-b6e5-8c8ae5f19f44)]
00144 interface sbIFileDownloaderListener : nsISupports
00145 {
00150   void onProgress();
00151 
00152 
00157   void onComplete();
00158 };
00159 
00160 
00161 //
00162 // C++ defs.
00163 //
00164 
00165 %{C++
00166 #define SB_FILEDOWNLOADER_CONTRACTID \
00167           "@songbirdnest.com/Songbird/FileDownloader;1"
00168 %}C++
00169 

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