sw/inc/IDocumentTimerAccess.hxx

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