LibreOffice Module sw (master) 1
|
SfxPoolItem subclass for footnotes and endnotes, stored in the anchor text node. More...
#include <fmtftn.hxx>
Public Member Functions | |
SwFormatFootnote (bool bEndNote=false) | |
virtual | ~SwFormatFootnote () override |
virtual bool | operator== (const SfxPoolItem &) const override |
"Pure virtual methods" of SfxPoolItem. More... | |
virtual SwFormatFootnote * | Clone (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 SwTextFootnote * | GetTextFootnote () const |
SwTextFootnote * | GetTextFootnote () |
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 SfxPoolItem * | Clone (SfxItemPool *pPool=nullptr) const=0 |
std::unique_ptr< SfxPoolItem > | CloneSetWhich (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 | |
SwFormatFootnote & | operator= (const SwFormatFootnote &rFootnote)=delete |
SwFormatFootnote (const SwFormatFootnote &)=delete | |
Private Attributes | |
SwTextFootnote * | m_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... | |
unotools::WeakReference< SwXFootnote > | m_wXFootnote |
Friends | |
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) | |
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.
|
privatedelete |
Referenced by Clone().
SwFormatFootnote::SwFormatFootnote | ( | bool | bEndNote = false | ) |
Definition at line 126 of file atrftn.cxx.
|
overridevirtual |
Definition at line 187 of file atrftn.cxx.
|
overridevirtual |
Implements SfxPoolItem.
Definition at line 148 of file atrftn.cxx.
References m_aNumber, m_bEndNote, m_nNumber, m_nNumberRLHidden, and SwFormatFootnote().
|
overridevirtual |
Reimplemented from SfxPoolItem.
Definition at line 282 of file atrftn.cxx.
References SfxPoolItem::dumpAsXml(), m_bEndNote, and m_pTextAttr.
Referenced by SwTextAttr::dumpAsXml().
uno::Reference< text::XTextRange > SwFormatFootnote::getAnchor | ( | SwDoc & | rDoc | ) | const |
Definition at line 269 of file atrftn.cxx.
References SwPosition::AdjustContent(), SwXTextRange::CreateXTextRange(), SwPaM::End(), SwPaM::GetMark(), SwTextAttr::GetStart(), SwTextFootnote::GetTextNode(), m_pTextAttr, SwPaM::SetMark(), and SwPaM::Start().
Referenced by SwTextFormatter::NewFootnoteNumPortion().
OUString SwFormatFootnote::GetFootnoteText | ( | SwRootFrame const & | rLayout | ) | const |
Definition at line 191 of file atrftn.cxx.
References SwTextNode::GetExpandText(), SwNodeIndex::GetNode(), SwNodeIndex::GetNodes(), SwTextFootnote::GetStartNode(), SwNode::GetTextNode(), SwNodes::GoNext(), SwNode::IsEndNode(), SwNode::IsTextNode(), and m_pTextAttr.
Referenced by SwEditWin::RequestHelp().
|
inline |
Definition at line 73 of file fmtftn.hxx.
Referenced by SwDoc::ChgPageDesc(), SwTextNode::CopyExpandText(), GetViewNumStr(), SwDoc::SetCurFootnote(), SwDoc::SetEndNoteInfo(), SwDoc::SetFootnoteInfo(), UnHide(), SwFootnoteIdxs::UpdateFootnote(), SwPageFrame::UpdateFootnoteNum(), and SwEndNoteInfo::UpdateFormatOrAttr().
|
inline |
Definition at line 74 of file fmtftn.hxx.
Referenced by SwDoc::ChgPageDesc(), SwTextNode::CopyExpandText(), GetViewNumStr(), SwDoc::SetCurFootnote(), SwDoc::SetEndNoteInfo(), SwDoc::SetFootnoteInfo(), UnHide(), SwPageFrame::UpdateFootnoteNum(), and SwEndNoteInfo::UpdateFormatOrAttr().
|
inline |
Definition at line 72 of file fmtftn.hxx.
Referenced by SwDoc::ChgPageDesc(), SwTextNode::CopyExpandText(), DocxAttributeOutput::FootnoteEndnoteReference(), SwHTMLWriter::GetFootEndNoteSym(), SwXFootnote::getLabel(), SwTextNode::GetMinMaxSize(), SwTextFrame::GetScalingOfSelectedText(), GetViewNumStr(), SwInsFootNoteDlg::Init(), OutHTML_SwFormatFootnote(), SwEditShell::SetCurFootnote(), SwDoc::SetCurFootnote(), SwDoc::SetEndNoteInfo(), SwDoc::SetFootnoteInfo(), UnHide(), SwFootnoteIdxs::UpdateAllFootnote(), SwFootnoteIdxs::UpdateFootnote(), SwPageFrame::UpdateFootnoteNum(), SwEndNoteInfo::UpdateFormatOrAttr(), WW8Export::WriteFootnoteBegin(), WW8_WrPlcSubDoc::WriteGenericPlc(), and RtfAttributeOutput::WriteTextFootnoteNumStr().
|
inline |
Definition at line 88 of file fmtftn.hxx.
|
inline |
Definition at line 87 of file fmtftn.hxx.
Referenced by SwXFootnote::createEnumeration(), sw::CreateParentXText(), SwXFootnote::createXTextCursor(), SwXFootnote::createXTextCursorByRange(), SwXFootnote::dispose(), SwXFootnote::getPropertyValue(), SwXFootnote::GetStartNode(), lcl_IsAtTextEnd(), MakeTextAttr(), OutHTML_SwFormatFootnote(), SetEndNote(), SwXFootnote::setLabel(), AttributeOutputBase::TextFootnote(), RtfAttributeOutput::TextFootnote_Impl(), WW8Export::WriteFootnoteBegin(), and WW8_WrPlcSubDoc::WriteGenericText().
OUString SwFormatFootnote::GetViewNumStr | ( | const SwDoc & | rDoc, |
SwRootFrame const * | pLayout, | ||
bool | bInclStrings = false |
||
) | const |
Returns string to be displayed of footnote / endnote.
return the view string of the foot/endnote
Definition at line 218 of file atrftn.cxx.
References SwUpdFootnoteEndNtAtEnd::FindSectNdWithEndAttr(), FTNEND_ATTXTEND_OWNNUMANDFMT, SwDoc::GetEndNoteInfo(), SwDoc::GetFootnoteInfo(), SwSection::GetFormat(), SwFormat::GetFormatAttr(), GetNumber(), GetNumberRLHidden(), GetNumStr(), SvxNumberType::GetNumStr(), SwFormatFootnoteEndAtTextEnd::GetPrefix(), SwEndNoteInfo::GetPrefix(), SwSectionNode::GetSection(), SwFormatFootnoteEndAtTextEnd::GetSuffix(), SwEndNoteInfo::GetSuffix(), SwFormatFootnoteEndAtTextEnd::GetSwNumType(), SfxEnumItem< typename EnumT >::GetValue(), IsEndNote(), SwRootFrame::IsHideRedlines(), SwEndNoteInfo::m_aFormat, m_pTextAttr, RES_END_AT_TXTEND(), and RES_FTN_AT_TXTEND().
Referenced by SwEnhancedPDFExportHelper::EnhancedPDFExport(), SwContentType::FillMemberList(), SwAccessibleFootnote::getAccessibleDescription(), SwHTMLWriter::GetFootEndNoteSym(), SwEditShell::GetSeqFootnoteList(), ModelToViewHelper::ModelToViewHelper(), SwTextFormatter::NewFootnoteNumPortion(), SwTextFormatter::NewFootnotePortion(), OutHTML_SwFormatFootnote(), SwAccessibleFootnote::SwAccessibleFootnote(), and SwGetRefField::UpdateField().
|
inline |
Definition at line 98 of file fmtftn.hxx.
Referenced by SwXFootnote::CreateXFootnote().
void SwFormatFootnote::InvalidateFootnote | ( | ) |
Definition at line 168 of file atrftn.cxx.
References RES_REMOVE_UNO_OBJECT().
|
inline |
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().
|
privatedelete |
|
overridevirtual |
"Pure virtual methods" of SfxPoolItem.
Implements SfxPoolItem.
Definition at line 139 of file atrftn.cxx.
References m_aNumber, m_bEndNote, and m_nNumber.
void SwFormatFootnote::SetEndNote | ( | bool | b | ) |
Definition at line 175 of file atrftn.cxx.
References SwTextFootnote::DelFrames(), GetTextFootnote(), and m_bEndNote.
Referenced by SwEditShell::GetCurFootnote(), and SwHistorySetFootnote::SetInDoc().
|
inline |
Definition at line 80 of file fmtftn.hxx.
References m_aNumber, m_nNumber, and m_nNumberRLHidden.
Referenced by SwEditShell::GetCurFootnote(), and SwEndNoteInfo::UpdateFormatOrAttr().
|
inline |
Definition at line 77 of file fmtftn.hxx.
Referenced by SwInsFootNoteDlg::Apply(), SwXFootnote::attach(), SwHTMLParser::FinishFootEndNote(), SwWrtShell::InsertFootnote(), and SwHistorySetFootnote::SetInDoc().
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().
Definition at line 158 of file atrftn.cxx.
References SfxHint::GetId(), RES_REMOVE_UNO_OBJECT(), and SetXFootnote().
|
friend |
Definition at line 48 of file fmtftn.hxx.
|
private |
User-defined 'Number'.
Definition at line 50 of file fmtftn.hxx.
Referenced by Clone(), SwTextFootnote::CopyFootnote(), operator==(), SetNumber(), and SwTextFootnote::SetNumber().
|
private |
Is it an End note?
Definition at line 53 of file fmtftn.hxx.
Referenced by Clone(), dumpAsXml(), operator==(), and SetEndNote().
|
private |
automatic sequence number
Definition at line 51 of file fmtftn.hxx.
Referenced by Clone(), operator==(), SetNumber(), and SwTextFootnote::SetNumber().
|
private |
automatic sequence number (hidden redlines)
Definition at line 52 of file fmtftn.hxx.
Referenced by Clone(), SetNumber(), and SwTextFootnote::SetNumber().
|
private |
My TextAttribute.
Definition at line 49 of file fmtftn.hxx.
Referenced by dumpAsXml(), getAnchor(), GetFootnoteText(), GetViewNumStr(), and SwTextFootnote::SwTextFootnote().
|
private |
Definition at line 55 of file fmtftn.hxx.
Referenced by SetXFootnote().