1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24  #ifndef IDOCUMENTTIMERACCESS_HXX_INCLUDED
25  #define IDOCUMENTTIMERACCESS_HXX_INCLUDED
26 
27  /** Get information about the current document state
28  */
29  class IDocumentTimerAccess
30  {
31  public:
32 	/**
33     Set modus to start, i.e. start timer if block count == 0
34 	*/
35 	virtual void StartIdling() = 0;
36 
37 	/**
38     Set modus to stopped, i.e. stop timer if running
39 	*/
40 	virtual void StopIdling() = 0;
41 
42 	/**
43     Increment block count, stop timer if running
44 	*/
45 	virtual void BlockIdling() = 0;
46 
47 	/**
48     Decrement block count, start timer if block count == 0 AND modus == start
49 	*/
50 	virtual void UnblockIdling() = 0;
51 
52  protected:
~IDocumentTimerAccess()53 	virtual ~IDocumentTimerAccess() {};
54  };
55 
56  #endif // IDOCUMENTTIMERACCESS_HXX_INCLUDED
57