sw/inc/SwDocIdle.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 #ifndef INCLUDED_SW_INC_SWDOCIDLE_HXX
  20 #define INCLUDED_SW_INC_SWDOCIDLE_HXX
  21
  22 #include <vcl/idle.hxx>
  23
  24 class SwDoc;
  25
  26 namespace sw
  27 {
  28 /**
  29  * An Idle, which is just ready to be scheduled for idle documents.
  30  *
  31  * Currently it's missing the notification, when busy documents become idle
  32  * again, so it relies on any task being triggered to recheck, which is
  33  * quite probably not a problem, as busy documents have a high chance to have
  34  * generated idle tasks.
  35  */
  36 class SwDocIdle final : public Idle
  37 {
  38 private:
  39     SwDoc& m_rDoc;
  40
  41     virtual sal_uInt64 UpdateMinPeriod(sal_uInt64 nTimeNow) const override;
  42
  43 public:
  44     SwDocIdle(SwDoc& doc);
  45     virtual ~SwDocIdle() override;
  46 };
  47 }
  48
  49 #endif
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */