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