LibreOffice Module sw (master)  1
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
SwTextFootnote Class Reference

#include <txtftn.hxx>

Inheritance diagram for SwTextFootnote:
[legend]
Collaboration diagram for SwTextFootnote:
[legend]

Public Member Functions

 SwTextFootnote (SwFormatFootnote &rAttr, sal_Int32 nStart)
 
virtual ~SwTextFootnote () override
 
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
 
- 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 SwFormatFlyCnt & GetFlyCnt () const
 
const SwTOXMark & GetTOXMark () const
 
const SwFormatRefMark & GetRefMark () const
 
const SwFormatINetFormat & GetINetFormat () const
 
const SwFormatRuby & GetRuby () const
 
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::unique_ptr< SwNodeIndex > m_pStartNode
 
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

Definition at line 31 of file txtftn.hxx.

Constructor & Destructor Documentation

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

Definition at line 279 of file atrftn.cxx.

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

SwTextFootnote::~SwTextFootnote ( )
overridevirtual

Definition at line 288 of file atrftn.cxx.

References SetStartNode().

Member Function Documentation

void SwTextFootnote::CheckCondColl ( )

Definition at line 571 of file atrftn.cxx.

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

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

void SwTextFootnote::ChgTextNode ( SwTextNode *  pNew)
inline

Definition at line 48 of file txtftn.hxx.

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

Definition at line 393 of file atrftn.cxx.

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

void SwTextFootnote::DelFrames ( const SwRootFrame *  )

Definition at line 467 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_pStartNode, m_pTextNode, SwIterator< TElementType, TSource, eMode >::Next(), SwFootnoteBossFrame::RemoveFootnote(), and SwPageFrame::UpdateFootnoteNum().

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

sal_uInt16 SwTextFootnote::GetSeqRefNo ( ) const
inline

Definition at line 64 of file txtftn.hxx.

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

SwNodeIndex* SwTextFootnote::GetStartNode ( ) const
inline

Definition at line 41 of file txtftn.hxx.

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

const SwTextNode & SwTextFootnote::GetTextNode ( ) const
inline

Definition at line 69 of file txtftn.hxx.

References assert(), and m_pTextNode.

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

void SwTextFootnote::InvalidateNumberInLayout ( )

Definition at line 373 of file atrftn.cxx.

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

Referenced by SetNumber().

void SwTextFootnote::MakeNewTextSection ( SwNodes &  rNodes)

create a new nodes-array section for the footnote

Definition at line 437 of file atrftn.cxx.

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

Referenced by CopyFootnote().

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

Definition at line 359 of file atrftn.cxx.

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

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

void SwTextFootnote::SetSeqNo ( sal_uInt16  n)
inline

Definition at line 63 of file txtftn.hxx.

Referenced by SwXFootnote::attach().

void SwTextFootnote::SetSeqRefNo ( )

Set the sequence number for the current footnote.

Returns
The new sequence number or USHRT_MAX if invalid.

Definition at line 536 of file atrftn.cxx.

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

Referenced by SwXFootnote::attach().

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

Definition at line 293 of file atrftn.cxx.

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

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

void SwTextFootnote::SetUniqueSeqRefNo ( SwDoc &  rDoc)
static

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

Parameters
[in]rDocThe document to be processed.

Definition at line 557 of file atrftn.cxx.

References i.

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

Member Data Documentation

sal_uInt16 SwTextFootnote::m_nSeqNo
private

Definition at line 35 of file txtftn.hxx.

Referenced by SetSeqRefNo().

std::unique_ptr<SwNodeIndex> SwTextFootnote::m_pStartNode
private

Definition at line 33 of file txtftn.hxx.

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

SwTextNode* SwTextFootnote::m_pTextNode
private

Definition at line 34 of file txtftn.hxx.

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

The documentation for this class was generated from the following files:
Generated on Thu Jan 14 2021 06:15:28 for LibreOffice Module sw (master) by   doxygen 1.8.10