chrome/browser/idle.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_IDLE_H_
   6 #define CHROME_BROWSER_IDLE_H_
   7
   8 #include "base/callback.h"
   9
  10 enum IdleState {
  11   IDLE_STATE_ACTIVE = 0,
  12   IDLE_STATE_IDLE = 1,    // No activity within threshold.
  13   IDLE_STATE_LOCKED = 2,  // Only available on supported systems.
  14   IDLE_STATE_UNKNOWN = 3  // Used when waiting for the Idle state or in error
  15                           // conditions
  16 };
  17
  18 // For MacOSX, InitIdleMonitor needs to be called first to setup the monitor.
  19 // StopIdleMonitor should be called if it is not needed any more.
  20 #if defined(OS_MACOSX)
  21 void InitIdleMonitor();
  22 void StopIdleMonitor();
  23 #endif
  24
  25 typedef base::Callback<void(IdleState)> IdleCallback;
  26
  27 // Calculate the Idle state and notify the callback.
  28 void CalculateIdleState(unsigned int idle_threshold, IdleCallback notify);
  29
  30 // Checks synchronously if Idle state is IDLE_STATE_LOCKED.
  31 bool CheckIdleStateIsLocked();
  32
  33 #endif  // CHROME_BROWSER_IDLE_H_