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 /**
  24  * Handle the background jobs of a Writer document.
  25  *
  26  * Initially it's disabled and unblocked.
  27  *
  28  * Jobs include:
  29  *  * grammar checking
  30  *  * field updating
  31  *  * document layouting
  32  */
  33 class IDocumentTimerAccess
  34 {
  35 public:
  36     /**
  37      * Start the idle task.
  38      *
  39      * Depends on the block count and various document states.
  40      */
  41     virtual void StartIdling() = 0;
  42
  43     /**
  44      * Stop idle processing.
  45      */
  46     virtual void StopIdling() = 0;
  47
  48     /**
  49      * Increment block count.
  50      *
  51      * Prevents further background idle processing.
  52      * This doesn't guarantee the Idle task is not currently running!
  53      */
  54     virtual void BlockIdling() = 0;
  55
  56     /**
  57      * Decrement block count.
  58      *
  59      * May re-start the idle task, if active.
  60      */
  61     virtual void UnblockIdling() = 0;
  62
  63     /**
  64      * Is the document ready to be processed?
  65      */
  66     virtual bool IsDocIdle() const = 0;
  67
  68 protected:
  69     virtual ~IDocumentTimerAccess() {};
  70 };
  71
  72 #endif // INCLUDED_SW_INC_IDOCUMENTTIMERACCESS_HXX
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */