Back to index

lightning-sunbird  0.9+nobinonly
nsWatchTask.h
Go to the documentation of this file.
00001 /* -*- Mode: c++; tab-width: 2; indent-tabs-mode: nil; -*- */
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.org 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 
00038 
00039 #ifndef WatchTask_h__
00040 #define WatchTask_h__
00041 
00042 
00043 #ifndef XP_MACOSX
00044 #include <Retrace.h>
00045 #endif
00046 #include <Quickdraw.h>
00047 #include "prtypes.h"
00048 #include "gfxCore.h"
00049 
00050 //
00051 // class nsWatchTask
00052 //
00053 // A nice little class that installs/removes a VBL to set the cursor to
00054 // the watch if we're away from the event loop for a while. Will also
00055 // animate the watch cursor.
00056 //
00057 
00058 class nsWatchTask
00059 {
00060 public:
00061   nsWatchTask ( ) ;
00062   ~nsWatchTask ( ) ;
00063 
00064     // Registers the VBL task and does other various init tasks to begin
00065     // watching for time away from the event loop. It is ok to call other
00066     // methods on this object w/out calling Start().
00067   NS_GFX void Start ( ) ;
00068   
00069     // call from the main event loop
00070   NS_GFX void EventLoopReached ( ) ;
00071   
00072     // turn off when we know we're going into an area where it's ok
00073     // that WNE is not called (eg, the menu code)
00074   void Suspend ( ) { mSuspended = PR_TRUE; };
00075   void Resume ( ) { mSuspended = PR_FALSE; };
00076   
00077   static NS_GFX nsWatchTask& GetTask ( ) ;
00078   
00079 private:
00080 
00081   enum { 
00082     kRepeatInterval = 10,       // check every 1/6 of a second if we should show watch (10/60)
00083     kTicksToShowWatch = 45,     // show watch if haven't seen WNE for 3/4 second (45/60)
00084     kStepsInAnimation = 12
00085   };
00086   
00087     // the VBL task
00088   static pascal void DoWatchTask(nsWatchTask* theTaskPtr) ;
00089   
00090 #if !TARGET_CARBON
00091   VBLTask mTask;            // this must be first!!
00092 #endif
00093   long mChecksum;           // 'mozz' to validate we have real data at interrupt time (not needed?)
00094   void* mSelf;              // so we can get back to |this| from the static routine
00095   long mTicks;              // last time the event loop was hit
00096   Cursor mWatchCursor;      // the watch cursor
00097   PRPackedBool mBusy;       // are we currently spinning the cursor?
00098   PRPackedBool mSuspended;  // set if we've temporarily suspended operation
00099   PRPackedBool mInstallSucceeded;     // did we succeed in installing the task? (used in dtor)
00100   short mAnimation;         // stage of animation
00101   
00102 };
00103 
00104 
00105 #endif