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

#include <fmtftn.hxx>

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

Public Member Functions

 SwFormatFootnote (bool bEndNote=false)
 
virtual ~SwFormatFootnote () override
 
virtual bool operator== (const SfxPoolItem &) const override
 "Pure virtual methods" of SfxPoolItem. More...
 
virtual SfxPoolItemClone (SfxItemPool *pPool=nullptr) const override
 
virtual void Modify (SfxPoolItem const *pOld, SfxPoolItem const *pNew) 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
 
css::uno::WeakReference< css::text::XFootnote > const & GetXFootnote () const
 
void SetXFootnote (css::uno::Reference< css::text::XFootnote > const &xNote)
 
- Public Member Functions inherited from SfxPoolItem
void AddRef (sal_uInt32 n=1) const
 
virtual ~SfxPoolItem ()
 
void SetWhich (sal_uInt16 nId)
 
sal_uInt16 Which () const
 
bool operator!= (const SfxPoolItem &rItem) const
 
virtual bool operator< (const SfxPoolItem &) const
 
virtual bool IsSortable () const
 
virtual bool GetPresentation (SfxItemPresentation ePresentation, MapUnit eCoreMetric, MapUnit ePresentationMetric, OUString &rText, const IntlWrapper &rIntlWrapper) const
 
virtual void ScaleMetrics (long lMult, 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)
 
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 bool IsVoidItem () const
 
- Public Member Functions inherited from SwModify
 SwModify ()
 
void NotifyClients (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
void ModifyBroadcast (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
virtual void CallSwClientNotify (const SfxHint &rHint) const
 
virtual ~SwModify () override
 
void Add (SwClient *pDepend)
 
SwClientRemove (SwClient *pDepend)
 
bool HasWriterListeners () const
 
virtual bool GetInfo (SfxPoolItem &) const override
 
void LockModify ()
 
void UnlockModify ()
 
void SetInCache (bool bNew)
 
void SetInSwFntCache (bool bNew)
 
void SetInDocDTOR ()
 
bool IsModifyLocked () const
 
bool IsInCache () const
 
bool IsInSwFntCache () const
 
void CheckCaching (const sal_uInt16 nWhich)
 
bool HasOnlyOneListener () const
 
- Public Member Functions inherited from SwClient
 SwClient ()
 
 SwClient (SwClient &&) noexcept
 
virtual ~SwClient () override
 
virtual void SwClientNotify (const SwModify &, const SfxHint &rHint) override
 
std::unique_ptr< sw::ModifyChangedHintCheckRegistration (const SfxPoolItem *pOldValue)
 
virtual void ModifyNotification (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
void SwClientNotifyCall (const SwModify &rModify, const SfxHint &rHint)
 
const SwModifyGetRegisteredIn () const
 
SwModifyGetRegisteredIn ()
 
void EndListeningAll ()
 
void StartListeningToSameModifyAs (const SwClient &)
 
- Public Member Functions inherited from sw::WriterListener
bool IsLast () const
 
- Public Member Functions inherited from sw::BroadcasterMixin
 BroadcasterMixin ()=default
 
 BroadcasterMixin (BroadcasterMixin const &)=default
 
BroadcasterMixinoperator= (const BroadcasterMixin &)
 
SvtBroadcasterGetNotifier ()
 

Private Member Functions

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

Private Attributes

SwTextFootnotem_pTextAttr
 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...
 
css::uno::WeakReference< css::text::XFootnote > m_wXFootnote
 

Friends

class SwTextFootnote
 

Additional Inherited Members

- Protected Member Functions inherited from SfxPoolItem
 SfxPoolItem (sal_uInt16 nWhich=0)
 
 SfxPoolItem (const SfxPoolItem &rCopy)
 
- Protected Member Functions inherited from SwClient
 SwClient (SwModify *pToRegisterIn)
 
SwModifyGetRegisteredInNonConst () const
 
- Protected Member Functions inherited from sw::WriterListener
 WriterListener ()
 
virtual ~WriterListener () COVERITY_NOEXCEPT_FALSE
 

Detailed Description

Definition at line 40 of file fmtftn.hxx.

Constructor & Destructor Documentation

SwFormatFootnote::SwFormatFootnote ( const SwFormatFootnote )
privatedelete

Referenced by Clone().

SwFormatFootnote::SwFormatFootnote ( bool  bEndNote = false)

Definition at line 124 of file atrftn.cxx.

SwFormatFootnote::~SwFormatFootnote ( )
overridevirtual

Definition at line 181 of file atrftn.cxx.

Member Function Documentation

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

Implements SfxPoolItem.

Definition at line 143 of file atrftn.cxx.

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

uno::Reference< text::XTextRange > SwFormatFootnote::getAnchor ( SwDoc rDoc) const
OUString SwFormatFootnote::GetFootnoteText ( SwRootFrame const &  rLayout) const
sal_uInt16 SwFormatFootnote::GetNumber ( ) const
inline
sal_uInt16 SwFormatFootnote::GetNumberRLHidden ( ) const
inline
const OUString& SwFormatFootnote::GetNumStr ( ) const
inline
const SwTextFootnote* SwFormatFootnote::GetTextFootnote ( ) const
inline
SwTextFootnote* SwFormatFootnote::GetTextFootnote ( )
inline

Definition at line 87 of file fmtftn.hxx.

OUString SwFormatFootnote::GetViewNumStr ( const SwDoc rDoc,
SwRootFrame const *  pLayout,
bool  bInclStrings = false 
) const
css::uno::WeakReference<css::text::XFootnote> const& SwFormatFootnote::GetXFootnote ( ) const
inline

Definition at line 97 of file fmtftn.hxx.

Referenced by SwXFootnote::CreateXFootnote().

void SwFormatFootnote::InvalidateFootnote ( )

Definition at line 162 of file atrftn.cxx.

References SwModify::NotifyClients(), and RES_REMOVE_UNO_OBJECT.

bool SwFormatFootnote::IsEndNote ( ) const
inline

Definition at line 74 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(), SwInsFootNoteDlg::Init(), SwFootnoteBossFrame::InsertFootnote(), SwContentNode::IsAnyCondition(), SwAccessibleFootnote::IsEndnote(), lcl_FindContentFrame(), lcl_FindEndnote(), lcl_FindFootnotePos(), lcl_IsAtTextEnd(), SwContentFrame::MakeAll(), SwFlowFrame::MoveBwd(), SwContentFrame::MoveFootnoteCntFwd(), SwFootnoteBossFrame::MoveFootnotes(), SwTextFormatter::NewErgoSumPortion(), SwTextFormatter::NewFootnoteNumPortion(), SwTextFormatter::NewFootnotePortion(), SwTextFormatter::NewPortion(), SwASC_AttrIter::OutAttr(), SwHTMLWriter::OutFootEndNotes(), SwHTMLWriter::OutFootEndNoteSym(), OutHTML_SwFormatFootnote(), SwFootnoteBossFrame::RearrangeFootnotes(), SwTextFrame::RemoveFootnote(), SwEditWin::RequestHelp(), SwWW8FltRefStack::SetAttrInDoc(), SwDoc::SetCurFootnote(), SwEditShell::SetCurFootnote(), SwDoc::SetEndNoteInfo(), SwDoc::SetFootnoteInfo(), SwHistorySetFootnote::SetInDoc(), SwXFootnote::setLabel(), sw_RemoveFootnotes(), SwEndNoteInfo::SwClientNotify(), SwFootnoteSave::SwFootnoteSave(), AttributeOutputBase::TextFootnote(), WW8AttributeOutput::TextFootnote_Impl(), RtfAttributeOutput::TextFootnote_Impl(), DocxAttributeOutput::TextFootnote_Impl(), SwFootnoteIdxs::UpdateAllFootnote(), SwFootnoteIdxs::UpdateFootnote(), SwPageFrame::UpdateFootnoteNum(), WidowsAndOrphans::WidowsAndOrphans(), and WW8Export::WriteFootnoteBegin().

void SwFormatFootnote::Modify ( SfxPoolItem const *  pOld,
SfxPoolItem const *  pNew 
)
overridevirtual
SwFormatFootnote& SwFormatFootnote::operator= ( const SwFormatFootnote rFootnote)
privatedelete
bool SwFormatFootnote::operator== ( const SfxPoolItem rAttr) const
overridevirtual

"Pure virtual methods" of SfxPoolItem.

Implements SfxPoolItem.

Definition at line 134 of file atrftn.cxx.

References m_aNumber, m_bEndNote, and m_nNumber.

void SwFormatFootnote::SetEndNote ( bool  b)
void SwFormatFootnote::SetNumber ( const SwFormatFootnote rFootnote)
inline

Definition at line 79 of file fmtftn.hxx.

References m_aNumber, m_nNumber, and m_nNumberRLHidden.

Referenced by SwEditShell::GetCurFootnote().

void SwFormatFootnote::SetNumStr ( const OUString &  rStr)
inline
void SwFormatFootnote::SetXFootnote ( css::uno::Reference< css::text::XFootnote > const &  xNote)
inline

Definition at line 99 of file fmtftn.hxx.

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

Friends And Related Function Documentation

friend class SwTextFootnote
friend

Definition at line 45 of file fmtftn.hxx.

Member Data Documentation

OUString SwFormatFootnote::m_aNumber
private

User-defined 'Number'.

Definition at line 47 of file fmtftn.hxx.

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

bool SwFormatFootnote::m_bEndNote
private

Is it an End note?

Definition at line 50 of file fmtftn.hxx.

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

sal_uInt16 SwFormatFootnote::m_nNumber
private

automatic sequence number

Definition at line 48 of file fmtftn.hxx.

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

sal_uInt16 SwFormatFootnote::m_nNumberRLHidden
private

automatic sequence number (hidden redlines)

Definition at line 49 of file fmtftn.hxx.

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

SwTextFootnote* SwFormatFootnote::m_pTextAttr
private

My TextAttribute.

Definition at line 46 of file fmtftn.hxx.

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

css::uno::WeakReference<css::text::XFootnote> SwFormatFootnote::m_wXFootnote
private

Definition at line 52 of file fmtftn.hxx.


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