sbIJobProgress.idl

Go to the documentation of this file.

/*
//
// BEGIN SONGBIRD GPL
// 
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
// 
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
// 
// Software distributed under the License is distributed 
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either 
// express or implied. See the GPL for the specific language 
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this 
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc., 
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
// 
// END SONGBIRD GPL
//
 */

#include "nsISupports.idl"

interface nsIStringEnumerator;
interface sbIJobProgressListener;



[scriptable, uuid(13979e02-1dd2-11b2-9e89-eefb590278a8)]
interface sbIJobProgress : nsISupports
{
  const unsigned short STATUS_FAILED = 0x00;
  
  const unsigned short STATUS_SUCCEEDED = 0x10;
  
  const unsigned short STATUS_RUNNING = 0x20;
  
  readonly attribute unsigned short status;

  readonly attribute boolean blocked;

  readonly attribute AString statusText;

  readonly attribute AString titleText;
  
  
  readonly attribute unsigned long progress;
  
  readonly attribute unsigned long total;
  
  
  readonly attribute unsigned long errorCount;
  
  nsIStringEnumerator getErrorMessages();
  
  
  void addJobProgressListener(in sbIJobProgressListener aListener);
  
  void removeJobProgressListener(in sbIJobProgressListener aListener);
};



[scriptable, function, uuid(75302170-1174-11dd-bd0b-0200200c9a66)]
interface sbIJobProgressListener : nsISupports
{
  void onJobProgress(in sbIJobProgress aJobProgress);
};

[scriptable, uuid(2693a1e5-7e07-4730-bf3b-68e76dd95f90)]
interface sbIJobProgressTime : sbIJobProgress
{
  readonly attribute unsigned long elapsedTime;

  readonly attribute unsigned long remainingTime;

};