Back to index

lightning-sunbird  0.9+nobinonly
nsThrobber.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Mozilla Communicator client code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 #ifndef nsThrobber_h___
00038 #define nsThrobber_h___
00039 
00040 #include "nsIWidget.h"
00041 #include "nsVoidArray.h"
00042 #include "nsCRT.h"
00043 #include "nsCOMPtr.h"
00044 #include "nsITimer.h"
00045 
00046 class nsIImageGroup;
00047 struct nsRect;
00048 
00049 class nsThrobber : public nsISupports
00050 {
00051 public:
00052   static nsThrobber* NewThrobber();
00053 
00054   NS_DECL_AND_IMPL_ZEROING_OPERATOR_NEW
00055 
00056   NS_DECL_ISUPPORTS
00057 
00058 #if 0
00059   // nsIImageRequestObserver
00060   virtual void Notify(nsIImageRequest *aImageRequest,
00061                       nsIImage *aImage,
00062                       nsImageNotification aNotificationType,
00063                       PRInt32 aParam1, PRInt32 aParam2,
00064                       void *aParam3);
00065 
00066   virtual void NotifyError(nsIImageRequest *aImageRequest,
00067                            nsImageError aErrorType);
00068 #endif
00069 
00070   // nsThrobber
00071   nsresult Init(nsIWidget* aParent, const nsRect& aBounds,
00072                 const nsString& aFileNameMask, PRInt32 aNumImages);
00073   void Destroy();
00074   nsresult MoveTo(PRInt32 aX, PRInt32 aY);
00075   nsresult Show();
00076   nsresult Hide();
00077   nsresult Start();
00078   nsresult Stop();
00079 
00080 protected:
00081   nsThrobber();
00082   virtual ~nsThrobber();
00083 
00084   void Tick();
00085 
00086   nsresult LoadThrobberImages(const nsString& aFileNameMask,
00087                               PRInt32 aNumImages);
00088 
00089   void DestroyThrobberImages();
00090 
00091   PRInt32        mWidth;
00092   PRInt32        mHeight;
00093   nsIWidget*     mWidget;
00094   nsVoidArray*   mImages;
00095   PRInt32        mNumImages;
00096   PRInt32        mIndex;
00097 //  nsIImageGroup* mImageGroup;
00098   nsCOMPtr<nsITimer> mTimer;
00099   PRBool         mRunning;
00100   PRUint32       mCompletedImages;
00101 
00102   PRInt32        mPreferredWidth;
00103   PRInt32        mPreferredHeight;
00104 
00105   static nsThrobber* FindThrobberFor(nsIWidget* aWidget);
00106   static void AddThrobber(nsThrobber* aThrobber);
00107   static void RemoveThrobber(nsThrobber* aThrobber);
00108   static nsEventStatus PR_CALLBACK HandleThrobberEvent(nsGUIEvent *aEvent);
00109   static void ThrobTimerCallback(nsITimer *aTimer, void *aClosure);
00110 
00111   static nsVoidArray* gThrobbers;
00112   static PRInt32 gNumThrobbers;
00113 };
00114 
00115 #endif /* nsThrobber_h___ */