sw/inc/IDocumentState.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 IDOCUMENTSTATE_HXX_INCLUDED
  21  #define IDOCUMENTSTATE_HXX_INCLUDED
  22
  23  #include <tools/solar.h>
  24
  25  /** Get information about the current document state
  26  */
  27  class IDocumentState
  28  {
  29  public:
  30     /** Must be called manually at changes of format.
  31     */
  32     virtual void SetModified() = 0;
  33
  34     virtual void ResetModified() = 0;
  35
  36     /** Changes of document?
  37     */
  38     virtual bool IsModified() const = 0;
  39
  40     /** State of being loaded or not.
  41         Formerly DocInfo.
  42     */
  43     virtual bool IsLoaded() const = 0;
  44
  45     virtual bool IsUpdateExpFld() const  = 0;
  46
  47     virtual bool IsNewDoc() const = 0;
  48
  49     virtual bool IsPageNums() const = 0;
  50
  51     virtual void SetPageNums(bool b)    = 0;
  52
  53     virtual void SetNewDoc(bool b) = 0;
  54
  55     virtual void SetUpdateExpFldStat(bool b) = 0;
  56
  57     virtual void SetLoaded(bool b = sal_True) = 0;
  58
  59  protected:
  60     virtual ~IDocumentState() {};
  61  };
  62
  63  #endif // IDOCUMENTSTATE_HXX_INCLUDED
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */