LibreOffice Module sw (master)  1
fmtftn.hxx
Go to the documentation of this file.
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_FMTFTN_HXX
20 #define INCLUDED_SW_INC_FMTFTN_HXX
21 
22 #include <rtl/ustring.hxx>
23 #include <cppuhelper/weakref.hxx>
24 #include <svl/poolitem.hxx>
25 
26 #include "swdllapi.h"
27 #include "calbck.hxx"
28 
29 namespace com::sun::star::text {
30  class XFootnote;
31  class XTextRange;
32 }
33 
34 class SwDoc;
35 class SwTextFootnote;
36 class SwRootFrame;
37 
38 // ATT_FTN
39 
41  : public SfxPoolItem
42  , public sw::BroadcastingModify
43 {
44  friend class SwTextFootnote;
46  OUString m_aNumber;
47  sal_uInt16 m_nNumber;
48  sal_uInt16 m_nNumberRLHidden;
49  bool m_bEndNote;
50 
51  css::uno::WeakReference<css::text::XFootnote> m_wXFootnote;
52 
53  SwFormatFootnote& operator=(const SwFormatFootnote& rFootnote) = delete;
54  SwFormatFootnote( const SwFormatFootnote& ) = delete;
55 
56 public:
57  SwFormatFootnote( bool bEndNote = false );
58  virtual ~SwFormatFootnote() override;
59 
61  virtual bool operator==( const SfxPoolItem& ) const override;
62  virtual SwFormatFootnote* Clone( SfxItemPool* pPool = nullptr ) const override;
63 
64  virtual void SwClientNotify(const SwModify&, const SfxHint&) override;
65 
66  void InvalidateFootnote();
67 
68  const OUString& GetNumStr() const { return m_aNumber; }
69  sal_uInt16 GetNumber() const { return m_nNumber; }
70  sal_uInt16 GetNumberRLHidden() const { return m_nNumberRLHidden; }
71  bool IsEndNote() const { return m_bEndNote;}
72 
73  void SetNumStr( const OUString& rStr ) { m_aNumber = rStr; }
74  void SetEndNote( bool b );
75 
76  void SetNumber( const SwFormatFootnote& rFootnote )
77  {
78  m_nNumber = rFootnote.m_nNumber;
79  m_nNumberRLHidden = rFootnote.m_nNumberRLHidden;
80  m_aNumber = rFootnote.m_aNumber;
81  }
82 
83  const SwTextFootnote *GetTextFootnote() const { return m_pTextAttr; }
84  SwTextFootnote *GetTextFootnote() { return m_pTextAttr; }
85 
86  OUString GetFootnoteText(SwRootFrame const& rLayout) const;
87 
89  OUString GetViewNumStr(const SwDoc& rDoc, SwRootFrame const* pLayout,
90  bool bInclStrings = false) const;
91 
92  css::uno::Reference<css::text::XTextRange> getAnchor(SwDoc& rDoc) const;
93 
94  css::uno::WeakReference<css::text::XFootnote> const& GetXFootnote() const
95  { return m_wXFootnote; }
96  void SetXFootnote(css::uno::Reference<css::text::XFootnote> const& xNote)
97  { m_wXFootnote = xNote; }
98 };
99 
100 #endif
101 
102 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual bool operator==(const SfxPoolItem &) const =0
void SetXFootnote(css::uno::Reference< css::text::XFootnote > const &xNote)
Definition: fmtftn.hxx:96
virtual SfxPoolItem * Clone(SfxItemPool *pPool=nullptr) const =0
Definition: doc.hxx:188
void SetNumStr(const OUString &rStr)
Definition: fmtftn.hxx:73
SfxPoolItem & operator=(const SfxPoolItem &)=delete
SwTextFootnote * m_pTextAttr
My TextAttribute.
Definition: fmtftn.hxx:45
bool IsEndNote() const
Definition: fmtftn.hxx:71
SwTextFootnote * GetTextFootnote()
Definition: fmtftn.hxx:84
The root element of a Writer document layout.
Definition: rootfrm.hxx:82
const SwTextFootnote * GetTextFootnote() const
Definition: fmtftn.hxx:83
const OUString & GetNumStr() const
Definition: fmtftn.hxx:68
sal_uInt16 m_nNumber
automatic sequence number
Definition: fmtftn.hxx:47
OUString m_aNumber
User-defined 'Number'.
Definition: fmtftn.hxx:46
sal_uInt16 GetNumberRLHidden() const
Definition: fmtftn.hxx:70
#define SW_DLLPUBLIC
Definition: swdllapi.h:28
sal_uInt16 m_nNumberRLHidden
automatic sequence number (hidden redlines)
Definition: fmtftn.hxx:48
css::uno::WeakReference< css::text::XFootnote > m_wXFootnote
Definition: fmtftn.hxx:51
bool m_bEndNote
Is it an End note?
Definition: fmtftn.hxx:49
css::uno::WeakReference< css::text::XFootnote > const & GetXFootnote() const
Definition: fmtftn.hxx:94
void SetNumber(const SwFormatFootnote &rFootnote)
Definition: fmtftn.hxx:76
virtual void SwClientNotify(const SwModify &, const SfxHint &rHint) override
Definition: calbck.cxx:304
sal_uInt16 GetNumber() const
Definition: fmtftn.hxx:69