sd/source/ui/inc/tools/IdleDetection.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: IdleDetection.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SD_IDLE_DETECTION_HXX
  32 #define SD_IDLE_DETECTION_HXX
  33
  34 #include <sal/types.h>
  35
  36 class Window;
  37
  38 namespace sd { namespace tools {
  39
  40 /** Detect whether the system is idle and some time consuming operation may
  41     be carried out.  This class ditinguishes between different states of
  42     idle-ness.
  43 */
  44 class IdleDetection
  45 {
  46 public:
  47     /** When GetIdleState() returns this value, then the system is idle.
  48     */
  49     static const sal_Int32 IDET_IDLE = 0x0000;
  50
  51     /** There are system event pending.
  52     */
  53     static const sal_Int32 IDET_SYSTEM_EVENT_PENDING = 0x0001;
  54
  55     /** A full screen slide show is running and is active.  In contrast
  56         there may be a full screen show be running in an inactive window,
  57         i.e. in the background.
  58     */
  59     static const sal_Int32 IDET_FULL_SCREEN_SHOW_ACTIVE = 0x0002;
  60
  61     /** A slide show is running in a window.
  62     */
  63     static const sal_Int32 IDET_WINDOW_SHOW_ACTIVE = 0x0004;
  64
  65     /** A window is being painted.
  66     */
  67     static const sal_Int32 IDET_WINDOW_PAINTING = 0x0008;
  68
  69     /** Determine whether the system is idle.
  70         @param pWindow
  71             When a valid Window pointer is given then it is checked
  72             whether the window is currently being painting.
  73         @return
  74             This method either returns IDET_IDLE or a combination of
  75             IdleStates values or-ed together that describe what the system
  76             is currently doing so that the caller can decide what to do.
  77     */
  78     static sal_Int32 GetIdleState (const ::Window* pWindow = NULL);
  79
  80 private:
  81     /** Check whether there are input events pending.
  82     */
  83     static sal_Int32 CheckInputPending (void);
  84
  85     /** Check whether a slide show is running full screen or in a window.
  86     */
  87     static sal_Int32 CheckSlideShowRunning (void);
  88
  89     static sal_Int32 CheckWindowPainting (const ::Window& rWindow);
  90 };
  91
  92 } } // end of namespace ::sd::tools
  93
  94 #endif