← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/gfx/public/nsWatchTask.h

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/gfx/public/nsWatchTask.h
 
1
/* -*- Mode: c++; tab-width: 2; indent-tabs-mode: nil; -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
9
 *
 
10
 * Software distributed under the License is distributed on an "AS IS" basis,
 
11
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 
12
 * for the specific language governing rights and limitations under the
 
13
 * License.
 
14
 *
 
15
 * The Original Code is mozilla.org code.
 
16
 *
 
17
 * The Initial Developer of the Original Code is 
 
18
 * Netscape Communications Corporation.
 
19
 * Portions created by the Initial Developer are Copyright (C) 1998
 
20
 * the Initial Developer. All Rights Reserved.
 
21
 *
 
22
 * Contributor(s):
 
23
 *
 
24
 *
 
25
 * Alternatively, the contents of this file may be used under the terms of
 
26
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 
27
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 
28
 * in which case the provisions of the GPL or the LGPL are applicable instead
 
29
 * of those above. If you wish to allow use of your version of this file only
 
30
 * under the terms of either the GPL or the LGPL, and not to allow others to
 
31
 * use your version of this file under the terms of the NPL, indicate your
 
32
 * decision by deleting the provisions above and replace them with the notice
 
33
 * and other provisions required by the GPL or the LGPL. If you do not delete
 
34
 * the provisions above, a recipient may use your version of this file under
 
35
 * the terms of any one of the NPL, the GPL or the LGPL.
 
36
 *
 
37
 * ***** END LICENSE BLOCK ***** */
 
38
 
 
39
 
 
40
#ifndef WatchTask_h__
 
41
#define WatchTask_h__
 
42
 
 
43
 
 
44
#ifndef XP_MACOSX
 
45
#include <Retrace.h>
 
46
#endif
 
47
#include <Quickdraw.h>
 
48
#include "prtypes.h"
 
49
#include "nscore.h"
 
50
#include "nsComObsolete.h"
 
51
 
 
52
//
 
53
// class nsWatchTask
 
54
//
 
55
// A nice little class that installs/removes a VBL to set the cursor to
 
56
// the watch if we're away from the event loop for a while. Will also
 
57
// animate the watch cursor.
 
58
//
 
59
 
 
60
class nsWatchTask
 
61
{
 
62
public:
 
63
  nsWatchTask ( ) ;
 
64
  ~nsWatchTask ( ) ;
 
65
 
 
66
    // Registers the VBL task and does other various init tasks to begin
 
67
    // watching for time away from the event loop. It is ok to call other
 
68
    // methods on this object w/out calling Start().
 
69
  NS_GFX void Start ( ) ;
 
70
  
 
71
    // call from the main event loop
 
72
  NS_GFX void EventLoopReached ( ) ;
 
73
  
 
74
    // turn off when we know we're going into an area where it's ok
 
75
    // that WNE is not called (eg, the menu code)
 
76
  void Suspend ( ) { mSuspended = PR_TRUE; };
 
77
  void Resume ( ) { mSuspended = PR_FALSE; };
 
78
  
 
79
  static NS_GFX nsWatchTask& GetTask ( ) ;
 
80
  
 
81
private:
 
82
 
 
83
  enum { 
 
84
    kRepeatInterval = 10,       // check every 1/6 of a second if we should show watch (10/60)
 
85
    kTicksToShowWatch = 45,     // show watch if haven't seen WNE for 3/4 second (45/60)
 
86
    kStepsInAnimation = 12
 
87
  };
 
88
  
 
89
    // the VBL task
 
90
  static pascal void DoWatchTask(nsWatchTask* theTaskPtr) ;
 
91
  
 
92
#if !TARGET_CARBON
 
93
  VBLTask mTask;            // this must be first!!
 
94
#endif
 
95
  long mChecksum;           // 'mozz' to validate we have real data at interrupt time (not needed?)
 
96
  void* mSelf;              // so we can get back to |this| from the static routine
 
97
  long mTicks;              // last time the event loop was hit
 
98
  Cursor mWatchCursor;      // the watch cursor
 
99
  PRPackedBool mBusy;       // are we currently spinning the cursor?
 
100
  PRPackedBool mSuspended;  // set if we've temporarily suspended operation
 
101
  PRPackedBool mInstallSucceeded;     // did we succeed in installing the task? (used in dtor)
 
102
  short mAnimation;         // stage of animation
 
103
  
 
104
};
 
105
 
 
106
 
 
107
#endif