1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #ifndef SD_IDLE_DETECTION_HXX
25*b1cdbd2cSJim Jagielski #define SD_IDLE_DETECTION_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski #include <sal/types.h>
28*b1cdbd2cSJim Jagielski 
29*b1cdbd2cSJim Jagielski class Window;
30*b1cdbd2cSJim Jagielski 
31*b1cdbd2cSJim Jagielski namespace sd { namespace tools {
32*b1cdbd2cSJim Jagielski 
33*b1cdbd2cSJim Jagielski /** Detect whether the system is idle and some time consuming operation may
34*b1cdbd2cSJim Jagielski     be carried out.  This class ditinguishes between different states of
35*b1cdbd2cSJim Jagielski     idle-ness.
36*b1cdbd2cSJim Jagielski */
37*b1cdbd2cSJim Jagielski class IdleDetection
38*b1cdbd2cSJim Jagielski {
39*b1cdbd2cSJim Jagielski public:
40*b1cdbd2cSJim Jagielski     /** When GetIdleState() returns this value, then the system is idle.
41*b1cdbd2cSJim Jagielski     */
42*b1cdbd2cSJim Jagielski     static const sal_Int32 IDET_IDLE = 0x0000;
43*b1cdbd2cSJim Jagielski 
44*b1cdbd2cSJim Jagielski     /** There are system event pending.
45*b1cdbd2cSJim Jagielski     */
46*b1cdbd2cSJim Jagielski     static const sal_Int32 IDET_SYSTEM_EVENT_PENDING = 0x0001;
47*b1cdbd2cSJim Jagielski 
48*b1cdbd2cSJim Jagielski     /** A full screen slide show is running and is active.  In contrast
49*b1cdbd2cSJim Jagielski         there may be a full screen show be running in an inactive window,
50*b1cdbd2cSJim Jagielski         i.e. in the background.
51*b1cdbd2cSJim Jagielski     */
52*b1cdbd2cSJim Jagielski     static const sal_Int32 IDET_FULL_SCREEN_SHOW_ACTIVE = 0x0002;
53*b1cdbd2cSJim Jagielski 
54*b1cdbd2cSJim Jagielski     /** A slide show is running in a window.
55*b1cdbd2cSJim Jagielski     */
56*b1cdbd2cSJim Jagielski     static const sal_Int32 IDET_WINDOW_SHOW_ACTIVE = 0x0004;
57*b1cdbd2cSJim Jagielski 
58*b1cdbd2cSJim Jagielski     /** A window is being painted.
59*b1cdbd2cSJim Jagielski     */
60*b1cdbd2cSJim Jagielski     static const sal_Int32 IDET_WINDOW_PAINTING = 0x0008;
61*b1cdbd2cSJim Jagielski 
62*b1cdbd2cSJim Jagielski     /** Determine whether the system is idle.
63*b1cdbd2cSJim Jagielski         @param pWindow
64*b1cdbd2cSJim Jagielski             When a valid Window pointer is given then it is checked
65*b1cdbd2cSJim Jagielski             whether the window is currently being painting.
66*b1cdbd2cSJim Jagielski         @return
67*b1cdbd2cSJim Jagielski             This method either returns IDET_IDLE or a combination of
68*b1cdbd2cSJim Jagielski             IdleStates values or-ed together that describe what the system
69*b1cdbd2cSJim Jagielski             is currently doing so that the caller can decide what to do.
70*b1cdbd2cSJim Jagielski     */
71*b1cdbd2cSJim Jagielski     static sal_Int32 GetIdleState (const ::Window* pWindow = NULL);
72*b1cdbd2cSJim Jagielski 
73*b1cdbd2cSJim Jagielski private:
74*b1cdbd2cSJim Jagielski     /** Check whether there are input events pending.
75*b1cdbd2cSJim Jagielski     */
76*b1cdbd2cSJim Jagielski     static sal_Int32 CheckInputPending (void);
77*b1cdbd2cSJim Jagielski 
78*b1cdbd2cSJim Jagielski     /** Check whether a slide show is running full screen or in a window.
79*b1cdbd2cSJim Jagielski     */
80*b1cdbd2cSJim Jagielski     static sal_Int32 CheckSlideShowRunning (void);
81*b1cdbd2cSJim Jagielski 
82*b1cdbd2cSJim Jagielski     static sal_Int32 CheckWindowPainting (const ::Window& rWindow);
83*b1cdbd2cSJim Jagielski };
84*b1cdbd2cSJim Jagielski 
85*b1cdbd2cSJim Jagielski } } // end of namespace ::sd::tools
86*b1cdbd2cSJim Jagielski 
87*b1cdbd2cSJim Jagielski #endif
88