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