Songbird / Development / Songbird Add-Ons API Documentation

components/job/public/sbIJobProgress.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 nsIStringEnumerator;
00030 interface sbIJobProgressListener;
00031 
00032 
00033 
00044 [scriptable, uuid(72287c30-1173-11dd-bd0b-0800200c9b66)]
00045 interface sbIJobProgress : nsISupports
00046 {
00050   const unsigned short STATUS_FAILED = 0x00;
00051   
00055   const unsigned short STATUS_SUCCEEDED = 0x10;
00056   
00060   const unsigned short STATUS_RUNNING = 0x20;
00061   
00066   readonly attribute unsigned short status;
00067   
00068   
00072   readonly attribute AString statusText;
00073 
00077   readonly attribute AString titleText;
00078   
00079   
00083   readonly attribute unsigned long progress;
00084   
00089   readonly attribute unsigned long total;
00090   
00091   
00095   readonly attribute unsigned long errorCount;
00096   
00101   nsIStringEnumerator getErrorMessages();
00102   
00103   
00109   void addJobProgressListener(in sbIJobProgressListener aListener);
00110   
00115   void removeJobProgressListener(in sbIJobProgressListener aListener);
00116 };
00117 
00118 
00119 
00124 [scriptable, function, uuid(75302170-1174-11dd-bd0b-0200200c9a66)]
00125 interface sbIJobProgressListener : nsISupports
00126 {
00132   void onJobProgress(in sbIJobProgress aJobProgress);
00133 };
00134 

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