sw/inc/IDocumentTimerAccess.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SW_INC_IDOCUMENTTIMERACCESS_HXX
  21 #define INCLUDED_SW_INC_IDOCUMENTTIMERACCESS_HXX
  22
  23 /** Manipulate background jobs of the document. It starts with a mode of
  24  'started' and a block count of 0.
  25  */
  26 class IDocumentTimerAccess
  27 {
  28 public:
  29     /**
  30     Set modus to 'start'.
  31     */
  32     virtual void StartIdling() = 0;
  33
  34     /**
  35     Set mode to 'stopped'.
  36     */
  37     virtual void StopIdling() = 0;
  38
  39     /**
  40     Increment block count.
  41     */
  42     virtual void BlockIdling() = 0;
  43
  44     /**
  45     Decrement block count.
  46     */
  47     virtual void UnblockIdling() = 0;
  48
  49     /**
  50     Do these jobs asynchronously: do grammar checking,
  51     do layout, and update fields.
  52     They will be delayed until mode is start AND block count == 0.
  53     The implementation might delay them further, for example
  54     it might wait until the application is idle.
  55     */
  56     virtual void StartBackgroundJobs() = 0;
  57
  58 protected:
  59     virtual ~IDocumentTimerAccess() {};
  60 };
  61
  62 #endif // INCLUDED_SW_INC_IDOCUMENTTIMERACCESS_HXX
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */