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 IDOCUMENTTIMERACCESS_HXX_INCLUDED
25*b1cdbd2cSJim Jagielski  #define IDOCUMENTTIMERACCESS_HXX_INCLUDED
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski  /** Get information about the current document state
28*b1cdbd2cSJim Jagielski  */
29*b1cdbd2cSJim Jagielski  class IDocumentTimerAccess
30*b1cdbd2cSJim Jagielski  {
31*b1cdbd2cSJim Jagielski  public:
32*b1cdbd2cSJim Jagielski 	/**
33*b1cdbd2cSJim Jagielski     Set modus to start, i.e. start timer if block count == 0
34*b1cdbd2cSJim Jagielski 	*/
35*b1cdbd2cSJim Jagielski 	virtual void StartIdling() = 0;
36*b1cdbd2cSJim Jagielski 
37*b1cdbd2cSJim Jagielski 	/**
38*b1cdbd2cSJim Jagielski     Set modus to stopped, i.e. stop timer if running
39*b1cdbd2cSJim Jagielski 	*/
40*b1cdbd2cSJim Jagielski 	virtual void StopIdling() = 0;
41*b1cdbd2cSJim Jagielski 
42*b1cdbd2cSJim Jagielski 	/**
43*b1cdbd2cSJim Jagielski     Increment block count, stop timer if running
44*b1cdbd2cSJim Jagielski 	*/
45*b1cdbd2cSJim Jagielski 	virtual void BlockIdling() = 0;
46*b1cdbd2cSJim Jagielski 
47*b1cdbd2cSJim Jagielski 	/**
48*b1cdbd2cSJim Jagielski     Decrement block count, start timer if block count == 0 AND modus == start
49*b1cdbd2cSJim Jagielski 	*/
50*b1cdbd2cSJim Jagielski 	virtual void UnblockIdling() = 0;
51*b1cdbd2cSJim Jagielski 
52*b1cdbd2cSJim Jagielski  protected:
~IDocumentTimerAccess()53*b1cdbd2cSJim Jagielski 	virtual ~IDocumentTimerAccess() {};
54*b1cdbd2cSJim Jagielski  };
55*b1cdbd2cSJim Jagielski 
56*b1cdbd2cSJim Jagielski  #endif // IDOCUMENTTIMERACCESS_HXX_INCLUDED
57