sw/inc/ftninfo.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_FTNINFO_HXX
  20 #define INCLUDED_SW_INC_FTNINFO_HXX
  21
  22 #include <rtl/ustring.hxx>
  23 #include "swdllapi.h"
  24 #include "calbck.hxx"
  25 #include <editeng/numitem.hxx>
  26
  27 class SwTextFormatColl;
  28 class SwPageDesc;
  29 class SwCharFormat;
  30 class SwDoc;
  31
  32 class SW_DLLPUBLIC SwEndNoteInfo : public SwClient
  33 {
  34     mutable sw::WriterMultiListener aDepends;
  35     mutable SwTextFormatColl* pTextFormatColl;
  36     mutable SwPageDesc* pPageDesc;
  37     mutable SwCharFormat* pCharFormat;
  38     mutable SwCharFormat* pAnchorFormat;
  39     OUString sPrefix;
  40     OUString sSuffix;
  41 protected:
  42     bool        m_bEndNote;
  43     virtual void SwClientNotify( const SwModify&, const SfxHint&) override;
  44
  45 public:
  46     SvxNumberType aFormat;
  47     sal_uInt16    nFootnoteOffset;
  48
  49     void ChgPageDesc(SwPageDesc* pDesc);
  50     SwPageDesc* GetPageDesc(SwDoc& rDoc) const;
  51     bool KnowsPageDesc() const;
  52     bool DependsOn(const SwPageDesc*) const;
  53
  54     void SetFootnoteTextColl(SwTextFormatColl& rColl);
  55     SwTextFormatColl* GetFootnoteTextColl() const { return pTextFormatColl; } // can be 0.
  56
  57     SwCharFormat* GetCharFormat(SwDoc &rDoc) const;
  58     void SetCharFormat( SwCharFormat* );
  59
  60     SwCharFormat* GetAnchorCharFormat(SwDoc &rDoc) const;
  61     void SetAnchorCharFormat(SwCharFormat*);
  62     SwCharFormat* GetCurrentCharFormat(const bool bAnchor) const;
  63
  64     SwEndNoteInfo & operator=(const SwEndNoteInfo&);
  65     bool operator==( const SwEndNoteInfo &rInf ) const;
  66
  67     SwEndNoteInfo();
  68     SwEndNoteInfo(const SwEndNoteInfo&);
  69
  70     const OUString& GetPrefix() const  { return sPrefix; }
  71     const OUString& GetSuffix() const  { return sSuffix; }
  72
  73     void SetPrefix(const OUString& rSet) { sPrefix = rSet; }
  74     void SetSuffix(const OUString& rSet) { sSuffix = rSet; }
  75 };
  76
  77 enum SwFootnotePos
  78 {
  79     // Momentarily only PAGE and CHAPTER. CHAPTER == document-endnotes.
  80     FTNPOS_PAGE = 1,
  81     FTNPOS_CHAPTER = 8
  82 };
  83
  84 enum SwFootnoteNum : unsigned
  85 {
  86     FTNNUM_PAGE, FTNNUM_CHAPTER, FTNNUM_DOC
  87 };
  88
  89 class SW_DLLPUBLIC SwFootnoteInfo final : public SwEndNoteInfo
  90 {
  91     using SwEndNoteInfo::operator ==;
  92
  93 public:
  94     OUString  aQuoVadis;
  95     OUString  aErgoSum;
  96     SwFootnotePos  ePos;
  97     SwFootnoteNum  eNum;
  98
  99     SwFootnoteInfo& operator=(const SwFootnoteInfo&);
 100
 101     bool operator==( const SwFootnoteInfo &rInf ) const;
 102
 103     SwFootnoteInfo();
 104     SwFootnoteInfo(const SwFootnoteInfo&);
 105 };
 106
 107 #endif
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */