sw/inc/IDocumentStatistics.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 struct SwDocStat;
  23
  24 /** Document statistics information
  25  */
  26 class IDocumentStatistics
  27 {
  28 public:
  29     /** DocInfo has changed (notify via DocShell):
  30         make required fields update.
  31     */
  32     virtual void DocInfoChgd(bool isEnableSetModified) = 0;
  33
  34     /** Document - Statistics
  35     */
  36     /// Returns a reference to the existing document statistics
  37     virtual const SwDocStat& GetDocStat() const = 0;
  38
  39     /**
  40       * Updates the document statistics if the document has been
  41       * modified and returns a reference to the result.
  42       * \param bCompleteAsync if true will return a partial result,
  43       * and potentially trigger a timeout to complete the work.
  44       * \param bFields if stat. fields should be updated
  45       */
  46     virtual const SwDocStat& GetUpdatedDocStat(bool bCompleteAsync, bool bFields) = 0;
  47
  48     /// Set the document statistics
  49     virtual void SetDocStat(const SwDocStat& rStat) = 0;
  50
  51     /**
  52       * Updates the internal document's statistics
  53       * \param bCompleteAsync if true it may do part of the
  54       * work and trigger a timeout to complete it.
  55       * \param bFields if stat. fields should be updated
  56       */
  57     virtual void UpdateDocStat(bool bCompleteAsync, bool bFields) = 0;
  58
  59 protected:
  60     virtual ~IDocumentStatistics(){};
  61 };
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */