xref: /aoo42x/main/sw/inc/IDocumentTimerAccess.hxx (revision cdf0e10c)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28  #ifndef IDOCUMENTTIMERACCESS_HXX_INCLUDED
29  #define IDOCUMENTTIMERACCESS_HXX_INCLUDED
30 
31  /** Get information about the current document state
32  */
33  class IDocumentTimerAccess
34  {
35  public:
36 	/**
37     Set modus to start, i.e. start timer if block count == 0
38 	*/
39 	virtual void StartIdling() = 0;
40 
41 	/**
42     Set modus to stopped, i.e. stop timer if running
43 	*/
44 	virtual void StopIdling() = 0;
45 
46 	/**
47     Increment block count, stop timer if running
48 	*/
49 	virtual void BlockIdling() = 0;
50 
51 	/**
52     Decrement block count, start timer if block count == 0 AND modus == start
53 	*/
54 	virtual void UnblockIdling() = 0;
55 
56  protected:
57 	virtual ~IDocumentTimerAccess() {};
58  };
59 
60  #endif // IDOCUMENTTIMERACCESS_HXX_INCLUDED
61