widget/src/xpwidgets/nsIdleService.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* vim:expandtab:shiftwidth=4:tabstop=4:
   3  */
   4 /* ***** BEGIN LICENSE BLOCK *****
   5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version
   8  * 1.1 (the "License"); you may not use this file except in compliance with
   9  * the License. You may obtain a copy of the License at
  10  * http://www.mozilla.org/MPL/
  11  *
  12  * Software distributed under the License is distributed on an "AS IS" basis,
  13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  14  * for the specific language governing rights and limitations under the
  15  * License.
  16  *
  17  * The Original Code is mozilla.org code.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Gijs Kruitbosch <gijskruitbosch@gmail.com>.
  21  * Portions created by the Initial Developer are Copyright (C) 2007
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *  Gijs Kruitbosch <gijskruitbosch@gmail.com>
  26  *
  27  * Alternatively, the contents of this file may be used under the terms of
  28  * either the GNU General Public License Version 2 or later (the "GPL"), or
  29  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30  * in which case the provisions of the GPL or the LGPL are applicable instead
  31  * of those above. If you wish to allow use of your version of this file only
  32  * under the terms of either the GPL or the LGPL, and not to allow others to
  33  * use your version of this file under the terms of the MPL, indicate your
  34  * decision by deleting the provisions above and replace them with the notice
  35  * and other provisions required by the GPL or the LGPL. If you do not delete
  36  * the provisions above, a recipient may use your version of this file under
  37  * the terms of any one of the MPL, the GPL or the LGPL.
  38  *
  39  * ***** END LICENSE BLOCK ***** */
  40
  41 #ifndef nsIdleService_h__
  42 #define nsIdleService_h__
  43
  44 #include "nsIIdleService.h"
  45 #include "nsCOMPtr.h"
  46 #include "nsITimer.h"
  47 #include "nsTArray.h"
  48 #include "nsIObserver.h"
  49
  50 // Class we can use to store an observer with its associated idle time
  51 // requirement and whether or not the observer thinks it's "idle".
  52 class IdleListener {
  53 public:
  54     nsCOMPtr<nsIObserver> observer;
  55     PRUint32 reqIdleTime;
  56     PRBool isIdle;
  57
  58     IdleListener(nsIObserver* obs, PRUint32 reqIT, PRBool aIsIdle = PR_FALSE) :
  59         observer(obs), reqIdleTime(reqIT), isIdle(aIsIdle) {}
  60     ~IdleListener() {}
  61 };
  62
  63 class nsIdleService : public nsIIdleService
  64 {
  65 public:
  66     nsIdleService();
  67
  68     // Implement nsIIdleService methods, but not the idleTime getter,
  69     // which is platform-dependent.
  70     NS_IMETHOD AddIdleObserver(nsIObserver* aObserver, PRUint32 aIdleTime);
  71     NS_IMETHOD RemoveIdleObserver(nsIObserver* aObserver, PRUint32 aIdleTime);
  72
  73     static void IdleTimerCallback(nsITimer* aTimer, void* aClosure);
  74
  75 protected:
  76     void CheckAwayState();
  77     ~nsIdleService();
  78
  79 private:
  80     nsCOMPtr<nsITimer> mTimer;
  81     nsTArray<IdleListener> mArrayListeners;
  82 };
  83
  84 #endif // nsIdleService_h__