SwTextFootnote Class Reference

SwTextAttr subclass for footnotes and endnotes. More...

#include <txtftn.hxx>

Inheritance diagram for SwTextFootnote:

Collaboration diagram for SwTextFootnote:

Public Member Functions
	SwTextFootnote (SwFormatFootnote &rAttr, sal_Int32 nStart)
virtual	~SwTextFootnote () override
const SwNodeIndex *	GetStartNode () const
void	SetStartNode (const SwNodeIndex *pNode, bool bDelNodes=true)
void	SetNumber (sal_uInt16 nNumber, sal_uInt16 nNumberRLHidden, const OUString &sNumStr)
void	CopyFootnote (SwTextFootnote &rDest, SwTextNode &rDestNode) const
const SwTextNode &	GetTextNode () const
void	ChgTextNode (SwTextNode *pNew)
void	MakeNewTextSection (SwNodes &rNodes)
	create a new nodes-array section for the footnote More...
void	DelFrames (const SwRootFrame *)
void	CheckCondColl ()
void	InvalidateNumberInLayout ()
void	SetSeqRefNo ()
	Set the sequence number for the current footnote. More...
void	SetSeqNo (sal_uInt16 n)
sal_uInt16	GetSeqRefNo () const
void	dumpAsXml (xmlTextWriterPtr pWriter) const override
Public Member Functions inherited from SwTextAttr
void	SetStart (sal_Int32 n)
	start position More...
sal_Int32	GetStart () const
virtual const sal_Int32 *	GetEnd () const
	end position More...
virtual void	SetEnd (sal_Int32)
const sal_Int32 *	End () const
sal_Int32	GetAnyEnd () const
	end (if available), else start More...
void	SetDontExpand (bool bDontExpand)
bool	DontExpand () const
bool	IsLockExpandFlag () const
bool	IsDontMoveAttr () const
bool	IsCharFormatAttr () const
bool	IsOverlapAllowedAttr () const
bool	IsPriorityAttr () const
void	SetPriorityAttr (bool bFlag)
bool	IsDontExpandStartAttr () const
bool	IsNesting () const
bool	HasDummyChar () const
bool	IsFormatIgnoreStart () const
bool	IsFormatIgnoreEnd () const
void	SetFormatIgnoreStart (bool bFlag)
void	SetFormatIgnoreEnd (bool bFlag)
bool	HasContent () const
const SfxPoolItem &	GetAttr () const
SfxPoolItem &	GetAttr ()
sal_uInt16	Which () const
bool	operator== (const SwTextAttr &) const
const SwFormatCharFormat &	GetCharFormat () const
const SwFormatAutoFormat &	GetAutoFormat () const
const SwFormatField &	GetFormatField () const
const SwFormatFootnote &	GetFootnote () const
const SwFormatLineBreak &	GetLineBreak () const
const SwFormatContentControl &	GetContentControl () const
const SwFormatFlyCnt &	GetFlyCnt () const
const SwTOXMark &	GetTOXMark () const
const SwFormatRefMark &	GetRefMark () const
const SwFormatINetFormat &	GetINetFormat () const
const SwFormatRuby &	GetRuby () const
virtual void	dumpAsXml (xmlTextWriterPtr pWriter) const

Static Public Member Functions
static void	SetUniqueSeqRefNo (SwDoc &rDoc)
	Set a unique sequential reference number for every footnote in the document. More...
Static Public Member Functions inherited from SwTextAttr
static void	Destroy (SwTextAttr *pToDestroy, SfxItemPool &rPool)
	destroy instance More...

Private Attributes
std::optional< SwNodeIndex >	m_oStartNode
SwTextNode *	m_pTextNode
sal_uInt16	m_nSeqNo

Additional Inherited Members
Protected Member Functions inherited from SwTextAttr
	SwTextAttr (SfxPoolItem &rAttr, sal_Int32 nStart)
virtual	~SwTextAttr () COVERITY_NOEXCEPT_FALSE
void	SetLockExpandFlag (bool bFlag)
void	SetDontMoveAttr (bool bFlag)
void	SetCharFormatAttr (bool bFlag)
void	SetOverlapAllowedAttr (bool bFlag)
void	SetDontExpandStartAttr (bool bFlag)
void	SetNesting (const bool bFlag)
void	SetHasDummyChar (const bool bFlag)
void	SetHasContent (const bool bFlag)
Protected Attributes inherited from SwTextAttr
SwpHints *	m_pHints = nullptr

Detailed Description

SwTextAttr subclass for footnotes and endnotes.

If it's an endnote is decided by the owned SwFormatFootnote's m_bEndNote.

Definition at line 33 of file txtftn.hxx.

Constructor & Destructor Documentation

SwTextFootnote()

SwTextFootnote::SwTextFootnote	(	SwFormatFootnote &	rAttr,
		sal_Int32	nStart
	)

Definition at line 295 of file atrftn.cxx.

References SwFormatFootnote::m_pTextAttr, and SwTextAttr::SetHasDummyChar().

~SwTextFootnote()

SwTextFootnote::~SwTextFootnote ( )

overridevirtual

Definition at line 304 of file atrftn.cxx.

References SetStartNode().

Member Function Documentation

CheckCondColl()

void SwTextFootnote::CheckCondColl

(

)

Definition at line 579 of file atrftn.cxx.

References SwNodeIndex::GetNode(), and GetStartNode().

Referenced by SwDoc::SetCurFootnote(), and SwHistorySetFootnote::SetInDoc().

ChgTextNode()

void SwTextFootnote::ChgTextNode ( SwTextNode *  pNew )

inline

Definition at line 50 of file txtftn.hxx.

CopyFootnote()

void SwTextFootnote::CopyFootnote	(	SwTextFootnote &	rDest,
		SwTextNode &	rDestNode
	)		const

Definition at line 401 of file atrftn.cxx.

References sw::DocumentContentOperationsManager::CopyWithFlyInFly(), SwNodes::Delete(), SwNode::EndOfSectionNode(), SwNode::GetDoc(), SwDoc::GetDocumentContentOperationsManager(), SwTextAttr::GetFootnote(), SwNodeIndex::GetIndex(), SwNodeIndex::GetNode(), SwDoc::GetNodes(), SwNode::GetNodes(), GetStartNode(), SwFormatFootnote::m_aNumber, m_oStartNode, m_pTextNode, and MakeNewTextSection().

DelFrames()

void SwTextFootnote::DelFrames

(

const SwRootFrame *

pRoot

)

Definition at line 475 of file atrftn.cxx.

References SwFootnoteFrame::Cut(), SwFrame::DestroyFrame(), SwFrame::FindPageFrame(), SwIterator< TElementType, TSource, eMode >::First(), SwFootnoteFrame::GetAttr(), SwFootnoteFrame::GetFollow(), SwFootnoteFrame::GetMaster(), SwNode::GetNodes(), SwFrame::getRootFrame(), SwFrame::GetUpper(), SwNodes::GoNext(), SwFrame::IsFootnoteFrame(), m_oStartNode, m_pTextNode, SwIterator< TElementType, TSource, eMode >::Next(), SwFootnoteBossFrame::RemoveFootnote(), and SwPageFrame::UpdateFootnoteNum().

Referenced by sw::RemoveFootnotesForNode(), SwFormatFootnote::SetEndNote(), SetStartNode(), and sw_DeleteFootnote().

dumpAsXml()

void SwTextFootnote::dumpAsXml ( xmlTextWriterPtr  pWriter ) const

overridevirtual

Reimplemented from SwTextAttr.

Definition at line 585 of file atrftn.cxx.

References SwTextAttr::dumpAsXml(), SwNode::GetIndex(), m_nSeqNo, m_oStartNode, and m_pTextNode.

GetSeqRefNo()

sal_uInt16 SwTextFootnote::GetSeqRefNo ( ) const

inline

Definition at line 66 of file txtftn.hxx.

Referenced by SwXFootnote::getPropertyValue(), SwEditShell::GetSeqFootnoteList(), MakeTextAttr(), AttributeOutputBase::TextFootnote(), and SwGetRefField::UpdateField().

GetStartNode()

const SwNodeIndex * SwTextFootnote::GetStartNode ( ) const

inline

Definition at line 43 of file txtftn.hxx.

Referenced by SwFootnoteBossFrame::AppendFootnote(), CheckCondColl(), SwTextFrame::ConnectFootnote(), CopyFootnote(), SwXFootnote::createEnumeration(), sw::CreateParentXText(), SwXFootnote::createXTextCursor(), SwXFootnote::createXTextCursorByRange(), SwWW8ImplReader::End_Footnote(), SwFootnoteBossFrame::FindFootnote(), SwNode::FindPageDesc(), SwFormatFootnote::GetFootnoteText(), SwEditShell::GetSeqFootnoteList(), SwHTMLTextFootnote::GetStartNode(), SwXFootnote::GetStartNode(), SwCursor::GotoFootnoteAnchor(), SwContentNode::IsAnyCondition(), SwContentAtPos::IsInRTLText(), lcl_ChangeFootnoteRef(), SwUndoAttr::RemoveIdx(), SwFootnoteBossFrame::ResetFootnote(), SwHistorySetFootnote::SwHistorySetFootnote(), RtfAttributeOutput::TextFootnote_Impl(), and WW8_WrPlcSubDoc::WriteGenericText().

GetTextNode()

const SwTextNode & SwTextFootnote::GetTextNode ( ) const

inline

Definition at line 72 of file txtftn.hxx.

References m_pTextNode.

Referenced by SwFootnoteBossFrame::AppendFootnote(), SwContentTree::BringFootnotesToAttention(), CmpL(), CmpLE(), SwXFootnote::dispose(), SwEnhancedPDFExportHelper::EnhancedPDFExport(), SwTextFrame::FindFootnoteRef(), SwNode::FindPageDesc(), SwUpdFootnoteEndNtAtEnd::FindSectNdWithEndAttr(), SwFormatFootnote::getAnchor(), GetBodyTextNode(), SwTextFrame::GetFootnoteLine(), SwFootnoteFrame::GetRefFromAttr(), SwCursor::GotoFootnoteAnchor(), SwCursor::GotoNextFootnoteAnchor(), SwCursor::GotoPrevFootnoteAnchor(), sw::IsFootnoteDeleted(), lcl_IsAtTextEnd(), SwTextFrame::Prepare(), sw::RemoveFootnotesForNode(), SwXFootnote::setLabel(), SwHistorySetFootnote::SwHistorySetFootnote(), SwFootnoteIdxs::UpdateAllFootnote(), SwFootnoteIdxs::UpdateFootnote(), and WW8Export::WriteFootnoteBegin().

InvalidateNumberInLayout()

void SwTextFootnote::InvalidateNumberInLayout

(

)

Definition at line 381 of file atrftn.cxx.

References SwNode::GetDoc(), SwTextAttr::GetFootnote(), SwDoc::GetNodes(), m_oStartNode, m_pTextNode, and SwTextNode::TriggerNodeUpdate().

Referenced by SetNumber().

MakeNewTextSection()

void SwTextFootnote::MakeNewTextSection

(

SwNodes &

rNodes

)

create a new nodes-array section for the footnote

Definition at line 445 of file atrftn.cxx.

References SwNodes::GetDoc(), SwDoc::GetEndNoteInfo(), SwNodes::GetEndOfInserts(), SwTextAttr::GetFootnote(), SwDoc::GetFootnoteInfo(), SwEndNoteInfo::GetFootnoteTextColl(), SwDoc::getIDocumentStylePoolAccess(), IDocumentStylePoolAccess::GetTextCollFromPool(), m_oStartNode, SwNodes::MakeTextSection(), RES_POOLCOLL_ENDNOTE, RES_POOLCOLL_FOOTNOTE, and SwFootnoteStartNode.

Referenced by CopyFootnote().

SetNumber()

void SwTextFootnote::SetNumber	(	sal_uInt16	nNumber,
		sal_uInt16	nNumberRLHidden,
		const OUString &	sNumStr
	)

Definition at line 367 of file atrftn.cxx.

References SwTextAttr::GetFootnote(), InvalidateNumberInLayout(), SwFormatFootnote::m_aNumber, SwFormatFootnote::m_nNumber, and SwFormatFootnote::m_nNumberRLHidden.

Referenced by SwDoc::ChgPageDesc(), SwWW8ImplReader::End_Footnote(), SwDoc::SetCurFootnote(), SwDoc::SetEndNoteInfo(), SwDoc::SetFootnoteInfo(), SwFootnoteIdxs::UpdateAllFootnote(), SwFootnoteIdxs::UpdateFootnote(), and SwPageFrame::UpdateFootnoteNum().

SetSeqNo()

void SwTextFootnote::SetSeqNo ( sal_uInt16  n )

inline

Definition at line 65 of file txtftn.hxx.

References n.

Referenced by SwXFootnote::attach(), and SwWW8ImplReader::End_Footnote().

SetSeqRefNo()

void SwTextFootnote::SetSeqRefNo

(

)

Set the sequence number for the current footnote.

Returns

The new sequence number or USHRT_MAX if invalid.

Definition at line 544 of file atrftn.cxx.

References SwNode::GetDoc(), SwDoc::IsInReading(), m_nSeqNo, and m_pTextNode.

Referenced by SwXFootnote::attach().

SetStartNode()

void SwTextFootnote::SetStartNode	(	const SwNodeIndex *	pNode,
		bool	bDelNodes = true
	)

Definition at line 309 of file atrftn.cxx.

References o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::begin(), IDocumentContentOperations::DeleteSection(), DelFrames(), o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::erase(), SwNode::GetDoc(), SwDoc::GetFootnoteIdxs(), SwDoc::getIDocumentContentOperations(), SwDoc::IsInDtor(), m_oStartNode, m_pTextNode, n, size, and SwFootnoteIdxs::UpdateFootnote().

Referenced by SwHistorySetFootnote::SetInDoc(), SwHistorySetFootnote::SwHistorySetFootnote(), and ~SwTextFootnote().

SetUniqueSeqRefNo()

void SwTextFootnote::SetUniqueSeqRefNo ( SwDoc &  rDoc )

static

Set a unique sequential reference number for every footnote in the document.

Parameters

[in]

rDoc

The document to be processed.

Definition at line 565 of file atrftn.cxx.

References i.

Referenced by SwDoc::SetAllUniqueFlyNames(), and SwDocShell::UpdateLinks().

Member Data Documentation

m_nSeqNo

sal_uInt16 SwTextFootnote::m_nSeqNo

private

Definition at line 37 of file txtftn.hxx.

Referenced by dumpAsXml(), and SetSeqRefNo().

m_oStartNode

std::optional<SwNodeIndex> SwTextFootnote::m_oStartNode

private

Definition at line 35 of file txtftn.hxx.

Referenced by CopyFootnote(), DelFrames(), dumpAsXml(), InvalidateNumberInLayout(), MakeNewTextSection(), and SetStartNode().

m_pTextNode

SwTextNode* SwTextFootnote::m_pTextNode

private

Definition at line 36 of file txtftn.hxx.

Referenced by CopyFootnote(), DelFrames(), dumpAsXml(), GetTextNode(), InvalidateNumberInLayout(), SetSeqRefNo(), and SetStartNode().

---

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

• txtftn.hxx
• atrftn.cxx