Line data    Source code

       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 IDOCUMENTSTATISTICS_HXX_INCLUDED
      21             :  #define IDOCUMENTSTATISTICS_HXX_INCLUDED
      22             : 
      23             :  struct SwDocStat;
      24             : 
      25             :  /** Document statistics information
      26             :  */
      27         898 :  class IDocumentStatistics
      28             :  {
      29             :  public:
      30             : 
      31             :     /** DocInfo has changed (notify via DocShell):
      32             :         make required fields update.
      33             :     */
      34             :     virtual void DocInfoChgd() = 0;
      35             : 
      36             :     /** Document - Statistics
      37             :     */
      38             :     /// Returns a reference to the existing document statistics
      39             :     virtual const SwDocStat &GetDocStat() const = 0;
      40             : 
      41             :     /**
      42             :       * Updates the document statistics if the document has been
      43             :       * modified and returns a reference to the result.
      44             :       * \param bCompleteAsync if true will return a partial result,
      45             :       * and potentially trigger a timeout to complete the work.
      46             :       */
      47             :     virtual const SwDocStat &GetUpdatedDocStat(bool bCompleteAsync) = 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             :       */
      57             :     virtual void UpdateDocStat(bool bCompleteAsync) = 0;
      58             : 
      59             : protected:
      60         895 :     virtual ~IDocumentStatistics() {};
      61             :  };
      62             : 
      63             :  #endif // IDOCUMENTSTATISTICS_HXX_INCLUDED
      64             : 
      65             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */