LibreOffice Module sw (master) 1
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
SwFormatFootnote Class Referencefinal

SfxPoolItem subclass for footnotes and endnotes, stored in the anchor text node. More...

#include <fmtftn.hxx>

Inheritance diagram for SwFormatFootnote:
Collaboration diagram for SwFormatFootnote:

Public Member Functions

 SwFormatFootnote (bool bEndNote=false)
virtual ~SwFormatFootnote () override
virtual bool operator== (const SfxPoolItem &) const override
 "Pure virtual methods" of SfxPoolItem. More...
virtual SwFormatFootnoteClone (SfxItemPool *pPool=nullptr) const override
virtual void SwClientNotify (const SwModify &, const SfxHint &) override
void InvalidateFootnote ()
const OUString & GetNumStr () const
sal_uInt16 GetNumber () const
sal_uInt16 GetNumberRLHidden () const
bool IsEndNote () const
void SetNumStr (const OUString &rStr)
void SetEndNote (bool b)
void SetNumber (const SwFormatFootnote &rFootnote)
const SwTextFootnoteGetTextFootnote () const
SwTextFootnoteGetTextFootnote ()
OUString GetFootnoteText (SwRootFrame const &rLayout) const
OUString GetViewNumStr (const SwDoc &rDoc, SwRootFrame const *pLayout, bool bInclStrings=false) const
 Returns string to be displayed of footnote / endnote. More...
css::uno::Reference< css::text::XTextRange > getAnchor (SwDoc &rDoc) const
unotools::WeakReference< SwXFootnote > const & GetXFootnote () const
void SetXFootnote (rtl::Reference< SwXFootnote > const &xNote)
void dumpAsXml (xmlTextWriterPtr pWriter) const override
- Public Member Functions inherited from SfxPoolItem
void AddRef (sal_uInt32 n=1) const
virtual ~SfxPoolItem ()
void SetWhich (sal_uInt16 nId)
sal_uInt16 Which () const
T & StaticWhichCast (TypedWhichId< T > nId)
const T & StaticWhichCast (TypedWhichId< T > nId) const
T * DynamicWhichCast (TypedWhichId< T > nId)
const T * DynamicWhichCast (TypedWhichId< T > nId) const
virtual bool operator== (const SfxPoolItem &) const=0
bool operator!= (const SfxPoolItem &rItem) const
virtual bool operator< (const SfxPoolItem &) const
virtual bool IsSortable () const
virtual bool HasLookup () const
virtual lookup_iterator Lookup (lookup_iterator, lookup_iterator end) const
virtual bool GetPresentation (SfxItemPresentation ePresentation, MapUnit eCoreMetric, MapUnit ePresentationMetric, OUString &rText, const IntlWrapper &rIntlWrapper) const
virtual void ScaleMetrics (tools::Long lMult, tools::Long lDiv)
virtual bool HasMetrics () const
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt8 nMemberId=0) const
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt8 nMemberId)
virtual SfxPoolItemClone (SfxItemPool *pPool=nullptr) const=0
std::unique_ptr< SfxPoolItemCloneSetWhich (sal_uInt16 nNewWhich) const
std::unique_ptr< T > CloneSetWhich (TypedWhichId< T > nId) const
sal_uInt32 GetRefCount () const
SfxItemKind GetKind () const
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const
virtual boost::property_tree::ptree dumpAsJSON () const
virtual bool IsVoidItem () const

Private Member Functions

SwFormatFootnoteoperator= (const SwFormatFootnote &rFootnote)=delete
 SwFormatFootnote (const SwFormatFootnote &)=delete

Private Attributes

 My TextAttribute. More...
OUString m_aNumber
 User-defined 'Number'. More...
sal_uInt16 m_nNumber
 automatic sequence number More...
sal_uInt16 m_nNumberRLHidden
 automatic sequence number (hidden redlines) More...
bool m_bEndNote
 Is it an End note? More...
unotools::WeakReference< SwXFootnotem_wXFootnote


class SwTextFootnote

Additional Inherited Members

- Public Types inherited from SfxPoolItem
typedef std::vector< SfxPoolItem * >::const_iterator lookup_iterator
- Protected Member Functions inherited from SfxPoolItem
 SfxPoolItem (sal_uInt16 nWhich=0)
 SfxPoolItem (const SfxPoolItem &rCopy)

Detailed Description

SfxPoolItem subclass for footnotes and endnotes, stored in the anchor text node.

The start node for the footnote content is defined by m_pTextAttr.

Definition at line 44 of file fmtftn.hxx.

Constructor & Destructor Documentation

◆ SwFormatFootnote() [1/2]

SwFormatFootnote::SwFormatFootnote ( const SwFormatFootnote )

Referenced by Clone().

◆ SwFormatFootnote() [2/2]

SwFormatFootnote::SwFormatFootnote ( bool  bEndNote = false)

Definition at line 126 of file atrftn.cxx.

◆ ~SwFormatFootnote()

SwFormatFootnote::~SwFormatFootnote ( )

Definition at line 187 of file atrftn.cxx.

Member Function Documentation

◆ Clone()

SwFormatFootnote * SwFormatFootnote::Clone ( SfxItemPool pPool = nullptr) const

Implements SfxPoolItem.

Definition at line 148 of file atrftn.cxx.

References m_aNumber, m_bEndNote, m_nNumber, m_nNumberRLHidden, and SwFormatFootnote().

◆ dumpAsXml()

void SwFormatFootnote::dumpAsXml ( xmlTextWriterPtr  pWriter) const

Reimplemented from SfxPoolItem.

Definition at line 282 of file atrftn.cxx.

References SfxPoolItem::dumpAsXml(), m_bEndNote, and m_pTextAttr.

Referenced by SwTextAttr::dumpAsXml().

◆ getAnchor()

uno::Reference< text::XTextRange > SwFormatFootnote::getAnchor ( SwDoc rDoc) const

◆ GetFootnoteText()

OUString SwFormatFootnote::GetFootnoteText ( SwRootFrame const &  rLayout) const

◆ GetNumber()

sal_uInt16 SwFormatFootnote::GetNumber ( ) const

◆ GetNumberRLHidden()

sal_uInt16 SwFormatFootnote::GetNumberRLHidden ( ) const

◆ GetNumStr()

const OUString & SwFormatFootnote::GetNumStr ( ) const

◆ GetTextFootnote() [1/2]

SwTextFootnote * SwFormatFootnote::GetTextFootnote ( )

Definition at line 88 of file fmtftn.hxx.

◆ GetTextFootnote() [2/2]

const SwTextFootnote * SwFormatFootnote::GetTextFootnote ( ) const

◆ GetViewNumStr()

OUString SwFormatFootnote::GetViewNumStr ( const SwDoc rDoc,
SwRootFrame const *  pLayout,
bool  bInclStrings = false 
) const

◆ GetXFootnote()

unotools::WeakReference< SwXFootnote > const & SwFormatFootnote::GetXFootnote ( ) const

Definition at line 98 of file fmtftn.hxx.

Referenced by SwXFootnote::CreateXFootnote().

◆ InvalidateFootnote()

void SwFormatFootnote::InvalidateFootnote ( )

Definition at line 168 of file atrftn.cxx.


◆ IsEndNote()

bool SwFormatFootnote::IsEndNote ( ) const

Definition at line 75 of file fmtftn.hxx.

Referenced by SwFrame::AdjustNeighbourhood(), SwFootnoteBossFrame::AppendFootnote(), SwFootnoteBossFrame::CollectFootnotes_(), SwTextFrame::ConnectFootnote(), SwTextNode::CopyExpandText(), SwFootnoteContFrame::FindFootNote(), SwFrame::FindNext_(), SwUpdFootnoteEndNtAtEnd::FindSectNdWithEndAttr(), SwTextFormatter::FormatQuoVadis(), SwXFootnotes::getByIndex(), SwXFootnotes::getCount(), SwEditShell::GetCurFootnote(), SwUnoCursorHelper::getCursorPropertyValue(), SwHTMLWriter::GetFootEndNoteSym(), SwUpdFootnoteEndNtAtEnd::GetNumber(), SwFrame::GetPrevFootnoteLeaf(), SwEditShell::GetSeqFootnoteList(), SwFootnoteBossFrame::GetVarSpace(), GetViewNumStr(), SwEditShell::HasFootnotes(), IMPL_LINK(), SwInsFootNoteDlg::Init(), SwFootnoteBossFrame::InsertFootnote(), SwContentNode::IsAnyCondition(), SwAccessibleFootnote::IsEndnote(), lcl_FindContentFrame(), lcl_FindEndnote(), lcl_FindFootnotePos(), lcl_IsAtTextEnd(), SwContentFrame::MakeAll(), SwContentFrame::MoveFootnoteCntFwd(), SwFootnoteBossFrame::MoveFootnotes(), SwTextFormatter::NewErgoSumPortion(), SwTextFormatter::NewFootnoteNumPortion(), SwTextFormatter::NewFootnotePortion(), SwTextFormatter::NewPortion(), SwHTMLWriter::OutFootEndNotes(), SwHTMLWriter::OutFootEndNoteSym(), OutHTML_SwFormatFootnote(), SwFootnoteBossFrame::RearrangeFootnotes(), SwTextFrame::RemoveFootnote(), SwEditWin::RequestHelp(), SwWW8FltRefStack::SetAttrInDoc(), SwEditShell::SetCurFootnote(), SwDoc::SetCurFootnote(), SwDoc::SetEndNoteInfo(), SwDoc::SetFootnoteInfo(), SwHistorySetFootnote::SetInDoc(), SwXFootnote::setLabel(), sw_RemoveFootnotes(), AttributeOutputBase::TextFootnote(), DocxAttributeOutput::TextFootnote_Impl(), WW8AttributeOutput::TextFootnote_Impl(), RtfAttributeOutput::TextFootnote_Impl(), SwFootnoteIdxs::UpdateAllFootnote(), SwFootnoteIdxs::UpdateFootnote(), SwPageFrame::UpdateFootnoteNum(), SwEndNoteInfo::UpdateFormatOrAttr(), WidowsAndOrphans::WidowsAndOrphans(), and WW8Export::WriteFootnoteBegin().

◆ operator=()

SwFormatFootnote & SwFormatFootnote::operator= ( const SwFormatFootnote rFootnote)

◆ operator==()

bool SwFormatFootnote::operator== ( const SfxPoolItem rAttr) const

"Pure virtual methods" of SfxPoolItem.

Implements SfxPoolItem.

Definition at line 139 of file atrftn.cxx.

References m_aNumber, m_bEndNote, and m_nNumber.

◆ SetEndNote()

void SwFormatFootnote::SetEndNote ( bool  b)

◆ SetNumber()

void SwFormatFootnote::SetNumber ( const SwFormatFootnote rFootnote)

Definition at line 80 of file fmtftn.hxx.

References m_aNumber, m_nNumber, and m_nNumberRLHidden.

Referenced by SwEditShell::GetCurFootnote(), and SwEndNoteInfo::UpdateFormatOrAttr().

◆ SetNumStr()

void SwFormatFootnote::SetNumStr ( const OUString &  rStr)

◆ SetXFootnote()

void SwFormatFootnote::SetXFootnote ( rtl::Reference< SwXFootnote > const &  xNote)

Definition at line 136 of file atrftn.cxx.

References m_wXFootnote.

Referenced by SwXFootnote::CreateXFootnote(), and SwClientNotify().

◆ SwClientNotify()

void SwFormatFootnote::SwClientNotify ( const SwModify ,
const SfxHint rHint 

Definition at line 158 of file atrftn.cxx.

References SfxHint::GetId(), RES_REMOVE_UNO_OBJECT(), and SetXFootnote().

Friends And Related Function Documentation

◆ SwTextFootnote

friend class SwTextFootnote

Definition at line 48 of file fmtftn.hxx.

Member Data Documentation

◆ m_aNumber

OUString SwFormatFootnote::m_aNumber

User-defined 'Number'.

Definition at line 50 of file fmtftn.hxx.

Referenced by Clone(), SwTextFootnote::CopyFootnote(), operator==(), SetNumber(), and SwTextFootnote::SetNumber().

◆ m_bEndNote

bool SwFormatFootnote::m_bEndNote

Is it an End note?

Definition at line 53 of file fmtftn.hxx.

Referenced by Clone(), dumpAsXml(), operator==(), and SetEndNote().

◆ m_nNumber

sal_uInt16 SwFormatFootnote::m_nNumber

automatic sequence number

Definition at line 51 of file fmtftn.hxx.

Referenced by Clone(), operator==(), SetNumber(), and SwTextFootnote::SetNumber().

◆ m_nNumberRLHidden

sal_uInt16 SwFormatFootnote::m_nNumberRLHidden

automatic sequence number (hidden redlines)

Definition at line 52 of file fmtftn.hxx.

Referenced by Clone(), SetNumber(), and SwTextFootnote::SetNumber().

◆ m_pTextAttr

SwTextFootnote* SwFormatFootnote::m_pTextAttr

My TextAttribute.

Definition at line 49 of file fmtftn.hxx.

Referenced by dumpAsXml(), getAnchor(), GetFootnoteText(), GetViewNumStr(), and SwTextFootnote::SwTextFootnote().

◆ m_wXFootnote

unotools::WeakReference<SwXFootnote> SwFormatFootnote::m_wXFootnote

Definition at line 55 of file fmtftn.hxx.

Referenced by SetXFootnote().

The documentation for this class was generated from the following files: