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