sbiTunesImporterJob.h

Go to the documentation of this file.

/*
 //
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2009 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
//
 */

#ifndef SBITUNESIMPORTERJOB_H_
#define SBITUNESIMPORTERJOB_H_

#include <nsStringAPI.h>
#include <nsCOMPtr.h>
#include <nsCOMArray.h>
#include <nsTArray.h>

#include <sbIJobProgress.h>
#include <sbIJobCancelable.h>

class nsIThread;

class sbiTunesImporterJob : public sbIJobProgress,
                            public sbIJobCancelable
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_SBIJOBPROGRESS
  NS_DECL_SBIJOBCANCELABLE

  static sbiTunesImporterJob * New();
  PRBool CancelRequested() const {
    return mCancelRequested;
  }
  nsresult SetStatus(PRUint32 aStatus);
  nsresult SetStatusText(nsAString const & aStatusText);
  nsresult SetTitleText(nsAString const & aTitleText);
  nsresult SetProgress(PRUint32 aProgress);
  nsresult SetTotal(PRUint32 aTotal);
  nsresult AddErrorMessage(nsAString const & aErrorMessage);
protected:  
  sbiTunesImporterJob();
  virtual ~sbiTunesImporterJob();
private:
  // Useful typedefs
  typedef nsTArray<nsString> StringArray;
  typedef nsCOMArray<sbIJobProgressListener> ListenerArray;

  PRBool mCanCancel;
  PRBool mCancelRequested;
  StringArray mErrorMessages;
  ListenerArray mListeners;
  PRUint32 mStatus;
  nsString mStatusText;
  nsString mTitleText;
  PRUint32 mProgress;
  PRUint32 mTotal;
  nsresult UpdateProgress();
  
  // Prevent copying and assignment
  sbiTunesImporterJob(sbiTunesImporterJob const &);
  sbiTunesImporterJob & operator = (sbiTunesImporterJob const);
};

#endif /* SBITUNESIMPORTERJOB_H_ */