sw/inc/txtftn.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_TXTFTN_HXX
  20 #define INCLUDED_SW_INC_TXTFTN_HXX
  21
  22 #include <rtl/ustring.hxx>
  23 #include "txatbase.hxx"
  24 #include "ndindex.hxx"
  25
  26 class SwNodeIndex;
  27 class SwNodes;
  28 class SwDoc;
  29 class SwRootFrame;
  30
  31 /// SwTextAttr subclass for footnotes and endnotes. If it's an endnote is decided by the owned
  32 /// SwFormatFootnote's m_bEndNote.
  33 class SW_DLLPUBLIC SwTextFootnote final : public SwTextAttr
  34 {
  35     std::optional<SwNodeIndex> m_oStartNode;
  36     SwTextNode * m_pTextNode;
  37     sal_uInt16 m_nSeqNo;
  38
  39 public:
  40     SwTextFootnote(
  41         const SfxPoolItemHolder& rAttr,
  42         sal_Int32 nStart );
  43     virtual ~SwTextFootnote() override;
  44
  45     const SwNodeIndex *GetStartNode() const { return m_oStartNode ? &*m_oStartNode : nullptr; }
  46     void SetStartNode( const SwNodeIndex *pNode, bool bDelNodes = true );
  47     void SetNumber(sal_uInt16 nNumber, sal_uInt16 nNumberRLHidden, const OUString &sNumStr);
  48     void CopyFootnote(SwTextFootnote & rDest, SwTextNode & rDestNode) const;
  49
  50     // Get and set TextNode pointer.
  51     inline const SwTextNode& GetTextNode() const;
  52     void ChgTextNode( SwTextNode* pNew ) { m_pTextNode = pNew; }
  53
  54     // Create a new empty TextSection for this footnote.
  55     void MakeNewTextSection( SwNodes& rNodes );
  56
  57     // Delete the FootnoteFrame from page.
  58     void DelFrames(const SwRootFrame *);
  59
  60     // Check conditional paragraph styles.
  61     void CheckCondColl();
  62
  63     void InvalidateNumberInLayout();
  64
  65     // For references to footnotes.
  66     void SetSeqRefNo();
  67     void SetSeqNo( sal_uInt16 n )       { m_nSeqNo = n; }   // For Readers.
  68     sal_uInt16 GetSeqRefNo() const      { return m_nSeqNo; }
  69
  70     static void SetUniqueSeqRefNo( SwDoc& rDoc );
  71     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  72 };
  73
  74 inline const SwTextNode& SwTextFootnote::GetTextNode() const
  75 {
  76     assert( m_pTextNode );
  77     return *m_pTextNode;
  78 }
  79
  80 #endif
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */