sbDeviceProgressListener.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2010 POTI, Inc.
 * http://www.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
 */

#ifndef _SB_DEVICE_PROGRESS_LISTENER_H_
#define _SB_DEVICE_PROGRESS_LISTENER_H_

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
//
// Device progress listener defs.
//
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
//
// Device progress listener imported services.
//
//------------------------------------------------------------------------------

// Songbird imports.
#include <sbIJobProgress.h>

// Mozilla imports.
#include <prmon.h>


//------------------------------------------------------------------------------
//
// Device progress listener classes.
//
//------------------------------------------------------------------------------

// Used class declarations.
class sbDeviceStatusHelper;

class sbDeviceProgressListener : public sbIJobProgressListener
{
  //----------------------------------------------------------------------------
  //
  // Public interface.
  //
  //----------------------------------------------------------------------------

public:

  //
  // Implemented interfaces.
  //

  NS_DECL_ISUPPORTS
  NS_DECL_SBIJOBPROGRESSLISTENER


  //
  // Public services.
  //

  static nsresult
    New(sbDeviceProgressListener** aDeviceProgressListener,
        PRMonitor*                 aCompleteNotifyMonitor = nsnull,
        sbDeviceStatusHelper*      aDeviceStatusHelper = nsnull);


  PRBool IsComplete();


  sbDeviceProgressListener(PRMonitor*            aCompleteNotifyMonitor,
                           sbDeviceStatusHelper* aDeviceStatusHelper);


  virtual ~sbDeviceProgressListener();


  //----------------------------------------------------------------------------
  //
  // Private interface.
  //
  //----------------------------------------------------------------------------

private:

  //
  // mCompleteNotifyMonitor     Monitor to notify upon job completion.
  // mDeviceStatusHelper        Helper to update device status.
  // mIsComplete                True if job has completed.
  //

  PRMonitor*                    mCompleteNotifyMonitor;
  sbDeviceStatusHelper*         mDeviceStatusHelper;
  PRInt32                       mIsComplete;
};


#endif /* _SB_DEVICE_PROGRESS_LISTENER_H_ */