SwFormatField Class Reference

#include <fmtfld.hxx>

Inheritance diagram for SwFormatField:

Collaboration diagram for SwFormatField:

Public Member Functions
	SwFormatField (const SwField &rField)
	Single argument constructors shall be explicit. More...
	SwFormatField (const SwFormatField &rAttr)
virtual	~SwFormatField () override
virtual bool	operator== (const SfxPoolItem &) const override
	"Pure virtual methods" of SfxPoolItem. More...
virtual SwFormatField *	Clone (SfxItemPool *pPool=nullptr) const override
virtual bool	GetInfo (SfxPoolItem &rInfo) const override
void	InvalidateField ()
const SwField *	GetField () const
SwField *	GetField ()
void	SetField (std::unique_ptr< SwField > pField)
	Sets current field. More...
const SwTextField *	GetTextField () const
SwTextField *	GetTextField ()
void	SetTextField (SwTextField &rTextField)
void	ClearTextField ()
void	RegisterToFieldType (SwFieldType &)
bool	IsFieldInDoc () const
bool	IsProtect () const
SAL_DLLPRIVATE unotools::WeakReference< SwXTextField > const &	GetXTextField () const
SAL_DLLPRIVATE void	SetXTextField (rtl::Reference< SwXTextField > const &xTextField)
void	dumpAsXml (xmlTextWriterPtr pWriter) const override
void	UpdateTextNode (const SfxPoolItem *pOld, const SfxPoolItem *pNew)
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
Public Member Functions inherited from sw::BroadcastingModify
virtual void	CallSwClientNotify (const SfxHint &rHint) const override
Public Member Functions inherited from SwModify
	SwModify ()
virtual void	CallSwClientNotify (const SfxHint &rHint) const
virtual	~SwModify () override
void	Add (SwClient *pDepend)
SwClient *	Remove (SwClient *pDepend)
bool	HasWriterListeners () const
bool	HasOnlyOneListener () const
virtual bool	GetInfo (SfxPoolItem &) const override
void	LockModify ()
void	UnlockModify ()
bool	IsModifyLocked () const
Public Member Functions inherited from SwClient
	SwClient ()
	SwClient (SwClient &&) noexcept
virtual	~SwClient () override
std::optional< sw::ModifyChangedHint >	CheckRegistration (const SfxPoolItem *pOldValue)
void	CheckRegistrationFormat (SwFormat &rOld)
const SwModify *	GetRegisteredIn () const
SwModify *	GetRegisteredIn ()
void	EndListeningAll ()
void	StartListeningToSameModifyAs (const SwClient &)
virtual bool	GetInfo (SfxPoolItem &) const
Public Member Functions inherited from sw::WriterListener
bool	IsLast () const
virtual const SwCellFrame *	DynCastCellFrame () const
virtual const SwTabFrame *	DynCastTabFrame () const
virtual const SwRowFrame *	DynCastRowFrame () const
virtual const SwTable *	DynCastTable () const
Public Member Functions inherited from sw::BroadcasterMixin
	BroadcasterMixin ()=default
	BroadcasterMixin (BroadcasterMixin const &)=default
BroadcasterMixin &	operator= (const BroadcasterMixin &)
SvtBroadcaster &	GetNotifier ()
Public Member Functions inherited from SfxBroadcaster
	SfxBroadcaster ()
	SfxBroadcaster (const SfxBroadcaster &rBC)
virtual	~SfxBroadcaster () COVERITY_NOEXCEPT_FALSE
void	Broadcast (const SfxHint &rHint)
bool	HasListeners () const
size_t	GetListenerCount () const
size_t	GetSizeOfVector () const
SfxListener *	GetListener (size_t nNo) const

Private Member Functions
	SwFormatField (sal_uInt16 nWhich)
virtual void	SwClientNotify (const SwModify &rModify, const SfxHint &rHint) override

Private Attributes
unotools::WeakReference< SwXTextField >	m_wXTextField
std::unique_ptr< SwField >	mpField
SwTextField *	mpTextField

Friends
void	InitCore ()

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)
virtual void	SwClientNotify (const SwModify &, const SfxHint &rHint) override
Protected Member Functions inherited from SwClient
	SwClient (SwModify *pToRegisterIn)
SwModify *	GetRegisteredInNonConst () const
virtual void	SwClientNotify (const SwModify &, const SfxHint &rHint) override
Protected Member Functions inherited from sw::WriterListener
	WriterListener ()
virtual	~WriterListener () COVERITY_NOEXCEPT_FALSE
virtual void	SwClientNotify (const SwModify &, const SfxHint &rHint)=0
Protected Member Functions inherited from SfxBroadcaster
void	Forward (SfxBroadcaster &rBC, const SfxHint &rHint)

Detailed Description

Definition at line 98 of file fmtfld.hxx.

Constructor & Destructor Documentation

SwFormatField() [1/3]

SwFormatField::SwFormatField ( sal_uInt16  nWhich )

private

Definition at line 49 of file atrfld.cxx.

Referenced by Clone().

SwFormatField() [2/3]

SwFormatField::SwFormatField ( const SwField &  rField )

explicit

Single argument constructors shall be explicit.

Definition at line 56 of file atrfld.cxx.

References SwModify::Add(), SwSetExpField::GetInputFlag(), SwField::GetTyp(), SwSetExpFieldType::GetType(), nsSwGetSetExpType::GSE_STRING, Input, mpField, Postit, RES_TXTATR_ANNOTATION(), RES_TXTATR_INPUTFIELD(), SetExp, SwSetExpField::SetFormatField(), and SfxPoolItem::SetWhich().

SwFormatField() [3/3]

SwFormatField::SwFormatField

(

const SwFormatField &

rAttr

)

Definition at line 94 of file atrfld.cxx.

References SwSetExpField::GetInputFlag(), SwField::GetTyp(), SwSetExpFieldType::GetType(), nsSwGetSetExpType::GSE_STRING, Input, mpField, Postit, RES_TXTATR_ANNOTATION(), RES_TXTATR_INPUTFIELD(), SetExp, SwSetExpField::SetFormatField(), SwInputField::SetFormatField(), and SfxPoolItem::SetWhich().

~SwFormatField()

SwFormatField::~SwFormatField ( )

overridevirtual

Definition at line 132 of file atrfld.cxx.

References SfxBroadcaster::Broadcast(), Database, Dde, SwModify::HasOnlyOneListener(), mpField, SwModify::Remove(), REMOVED, SetExp, User, and SwFieldType::Which().

Member Function Documentation

ClearTextField()

void SwFormatField::ClearTextField

(

)

Definition at line 196 of file atrfld.cxx.

References mpTextField.

Referenced by SwTextField::~SwTextField().

Clone()

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

overridevirtual

Implements SfxPoolItem.

Definition at line 212 of file atrfld.cxx.

References SwFormatField().

Referenced by SwWW8FltRefStack::RefToVar().

dumpAsXml()

void SwFormatField::dumpAsXml ( xmlTextWriterPtr  pWriter ) const

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 448 of file atrfld.cxx.

References SfxPoolItem::dumpAsXml(), mpField, and mpTextField.

Referenced by SwTextAttr::dumpAsXml().

GetField() [1/2]

SwField * SwFormatField::GetField ( )

inline

Definition at line 134 of file fmtfld.hxx.

GetField() [2/2]

const SwField * SwFormatField::GetField ( ) const

inline

Definition at line 130 of file fmtfld.hxx.

Referenced by SwXTextField::attach(), SwTaggedPDFHelper::BeginInlineStructureElements(), SwpHints::CalcFlags(), SwpHints::CalcHiddenParaField(), sw::annotation::SwAnnotationWin::CalcParent(), SwDoc::ChangeDBFields(), SwRefPageGetField::ChangeExpansion(), SwNodes::ChgNode(), SwDoc::ConvertFieldsToText(), SwTextField::CopyTextField(), sw::annotation::SwAnnotationWin::CountFollowing(), SwpHints::DeleteAtPos(), SwWrtShell::DelRight(), SwTextNode::DestroyAttr(), SwUndoFieldFromDoc::DoImpl(), SwContentTree::EditEntry(), SwTOXAuthority::equivalent(), SwTextField::ExpandTextField(), sw::DocumentFieldsManager::FieldsToExpand(), SwTOXAuthority::FillText(), AttributeOutputBase::GenerateBookmarksForSequenceField(), SwDoc::GetAllUsedDB(), SwTextAnnotationField::GetAnnotationMark(), SwDocUpdateField::GetBodyNode(), SwCursorShell::GetContentAtPos(), SwInputFieldList::GetField(), SwCursorShell::GetFieldAtCursor(), sw::DocumentFieldsManager::GetFieldAtPos(), SwTextInputField::GetFieldContent(), SwXTextField::Impl::GetFieldType(), SwAccessibleParagraph::GetFieldTypeNameAtIndex(), SwTOXAuthority::GetLevel(), SwTextNode::GetMinMaxSize(), SwPageFrame::GetModelPositionForViewPoint(), SwCursorShell::GetPostItFieldAtCursor(), sw::DocumentFieldsManager::GetRecordsPerDocument(), SwTextFrame::GetScalingOfSelectedText(), SwAuthorityFieldType::GetSequencePos(), SwTOXAuthority::GetText(), SwTableBox::GetValue(), SwPaM::HasReadonlySel(), SwHandleAnchorNodeChg::ImplDestroy(), sw::mark::AnnotationMark::InitDoc(), SwDocUpdateField::InsDelFieldInFieldLst(), SwHTMLParser::InsertComment(), SwTextNode::InsertHint(), SwWW8FltRefStack::IsFootnoteEdnBkmField(), SwTextFrame::IsHiddenNow(), sw::annotation::SwAnnotationWin::IsResolved(), SwTableBox::IsValidNumTextNd(), lcl_CopyHint(), lcl_ExportHints(), lcl_GetText(), lcl_IsNoEndTextAttrAtPos(), lcl_MakeFieldLst(), lcl_SelectByContentTypeAndAddress(), SwDocUpdateField::MakeFieldList_(), MakeTextAttr(), SwEditWin::MouseButtonDown(), SwTextFormatter::NewFieldPortion(), SwPostItMgr::Notify(), OutHTML_SwFormatField(), OutHTML_SwTextNode(), SwFEShell::RequestObjectResize(), SwFltControlStack::SetAttrInDoc(), SwWW8FltRefStack::SetAttrInDoc(), sw::annotation::SwAnnotationWin::SetPostItText(), sw::annotation::SwAnnotationWin::SetResolved(), SwTOXAuthority::sort_lt(), SwClientNotify(), AttributeOutputBase::TextField(), SwXTextField::TransmuteLeadToInputField(), SwpHints::TryInsertHint(), SwUndoFieldFromDoc::UndoImpl(), sw::DocumentFieldsManager::UpdateExpFieldsImpl(), sw::DocumentFieldsManager::UpdateField(), SwRefPageGetFieldType::UpdateField(), SwTextInputField::UpdateFieldContent(), SwEditShell::UpdateOneField(), SwEditWin::UpdatePointer(), and UpdateTextNode().

GetInfo()

bool SwFormatField::GetInfo ( SfxPoolItem &  rInfo ) const

overridevirtual

Reimplemented from SwModify.

Definition at line 426 of file atrfld.cxx.

References SwNode::GetNodes(), SwTextField::GetpTextNode(), mpTextField, RES_AUTOFMT_DOCNODE(), and SfxPoolItem::Which().

GetTextField() [1/2]

SwTextField * SwFormatField::GetTextField ( )

inline

Definition at line 152 of file fmtfld.hxx.

GetTextField() [2/2]

const SwTextField * SwFormatField::GetTextField ( ) const

inline

Definition at line 148 of file fmtfld.hxx.

Referenced by SwInputField::applyFieldContent(), sw::annotation::SwAnnotationWin::CalcParent(), SwDoc::ChangeDBFields(), SwTextField::CopyTextField(), sw::annotation::SwAnnotationWin::CountFollowing(), SwContentTree::EditEntry(), SwDoc::GetAllUsedDB(), SwAnnotationItem::GetAnchorPosition(), SwTableField::GetNodeOfFormula(), SwGetExpField::GetReferenceTextPos(), SwCursorShell::GotoFormatField(), sw::annotation::SwAnnotationWin::InitAnswer(), sw::sidebarwindows::SwFrameSidebarWinContainer::insert(), SwViewShell::IsAnyFieldInDoc(), SwDocUpdateField::MakeFieldList_(), OutHTML_SwFormatField(), sw::annotation::SwAnnotationWin::SetPosAndSize(), SwClientNotify(), SwTextFrame::SwClientNotify(), SwTOXAuthority::SwTOXAuthority(), AttributeOutputBase::TextField(), SwXTextField::TransmuteLeadToInputField(), sw::annotation::SwAnnotationWin::UpdateData(), SwAnnotationItem::UseElement(), and SwTextField::~SwTextField().

GetXTextField()

SAL_DLLPRIVATE unotools::WeakReference< SwXTextField > const & SwFormatField::GetXTextField ( ) const

inline

Definition at line 163 of file fmtfld.hxx.

Referenced by SwXTextField::CreateXTextField(), and SwXTextField::TransmuteLeadToInputField().

InvalidateField()

void SwFormatField::InvalidateField

(

)

Definition at line 217 of file atrfld.cxx.

References sw::BroadcastingModify::CallSwClientNotify(), and RES_REMOVE_UNO_OBJECT().

IsFieldInDoc()

bool SwFormatField::IsFieldInDoc

(

)

const

Definition at line 435 of file atrfld.cxx.

References SwTextField::IsFieldInDoc(), and mpTextField.

Referenced by SwNodes::ChgNode(), SwPostItMgr::Notify(), SwClientNotify(), UpdateTextNode(), and SwAnnotationItem::UseElement().

IsProtect()

bool SwFormatField::IsProtect

(

)

const

Definition at line 441 of file atrfld.cxx.

References SwTextField::GetpTextNode(), SwNode::IsProtect(), and mpTextField.

Referenced by SwTextFieldContent::IsProtect(), SwPostItContent::IsProtect(), and sw::annotation::SwAnnotationWin::IsProtected().

operator==()

bool SwFormatField::operator== ( const SfxPoolItem &  rAttr ) const

overridevirtual

"Pure virtual methods" of SfxPoolItem.

Implements SfxPoolItem.

Definition at line 201 of file atrfld.cxx.

References mpField.

RegisterToFieldType()

void SwFormatField::RegisterToFieldType

(

SwFieldType &

rType

)

Definition at line 171 of file atrfld.cxx.

References SwModify::Add().

Referenced by SwDoc::ChangeDBFields(), and SwpHints::TryInsertHint().

SetField()

void SwFormatField::SetField

(

std::unique_ptr< SwField >

pField

)

Sets current field.

Parameters

pField

new field

Attention: \n The current field will be destroyed before setting the new field.

Definition at line 176 of file atrfld.cxx.

References SfxBroadcaster::Broadcast(), CHANGED, Input, mpField, and SetExp.

Referenced by sw::DocumentFieldsManager::UpdateField().

SetTextField()

void SwFormatField::SetTextField

(

SwTextField &

rTextField

)

Definition at line 191 of file atrfld.cxx.

References mpTextField.

Referenced by SwTextField::SwTextField().

SetXTextField()

void SwFormatField::SetXTextField

(

rtl::Reference< SwXTextField > const &

xTextField

)

Definition at line 772 of file atrfld.cxx.

References m_wXTextField.

SwClientNotify()

void SwFormatField::SwClientNotify ( const SwModify &  rModify, const SfxHint &  rHint  )

overrideprivatevirtual

Reimplemented from SwModify.

Definition at line 223 of file atrfld.cxx.

References SwPosition::Assign(), SwPaM::DeleteMark(), IDocumentContentOperations::DeleteRange(), fnMoveForward, SwPaM::GetDoc(), GetField(), SfxHint::GetId(), SwDoc::getIDocumentContentOperations(), SwNode::GetNodes(), SwPaM::GetPoint(), SwTextField::GetpTextNode(), SwTextAttr::GetStart(), SwField::GetSubType(), GetTextField(), SwTextField::GetTextNode(), IDocumentContentOperations::InsertString(), SwDoc::IsClipBoard(), SwNodes::IsDocNodes(), sw::IsFieldDeletedInModel(), IsFieldInDoc(), sw::HasHiddenInformationNotesHint::m_rbHasHiddenInformationNotes, sw::FindFormatForFieldHint::m_rpFormat, sw::CollectPostItsHint::m_rvFormatFields, sw::GatherNodeIndexHint::m_rvNodeIndex, SwPaM::Move(), mpField, mpTextField, SwPaM::SetMark(), SwClient::SwClientNotify(), and UpdateTextNode().

UpdateTextNode()

void SwFormatField::UpdateTextNode	(	const SfxPoolItem *	pOld,
		const SfxPoolItem *	pNew
	)

Definition at line 308 of file atrfld.cxx.

References sw::BroadcastingModify::CallSwClientNotify(), DatabaseName, DbNextSet, DbNumSet, DbSetNumber, nsSwDocInfoSubType::DI_CHANGE, nsSwDocInfoSubType::DI_CUSTOM, nsSwDocInfoSubType::DI_SUBJECT, nsSwDocInfoSubType::DI_TITLE, DocInfo, SwTextField::ExpandTextField(), SwNode::GetDoc(), GetField(), SwTextAttr::GetFormatField(), GetRef, SwDocInfoField::GetSubType(), SwTextField::GetTextNode(), SwField::GetTyp(), SwUserFieldType::GetValue(), HiddenPara, IsFieldInDoc(), SwUserFieldType::IsValid(), m_wXTextField, mpField, mpTextField, RES_ATTRSET_CHG(), RES_DOCPOS_UPDATE(), RES_FMT_CHG(), RES_HIDDENPARA_PRINT(), RES_OBJECTDYING(), RES_REFMARKFLD_UPDATE(), RES_REMOVE_UNO_OBJECT(), SwTextNode::TriggerNodeUpdate(), User, SfxPoolItem::Which(), and SwFieldType::Which().

Referenced by SwClientNotify(), sw::DocumentFieldsManager::UpdateExpFieldsImpl(), and sw::DocumentFieldsManager::UpdateField().

Friends And Related Function Documentation

InitCore

void InitCore ( )

friend

Definition at line 449 of file init.cxx.

Member Data Documentation

m_wXTextField

unotools::WeakReference<SwXTextField> SwFormatField::m_wXTextField

private

Definition at line 106 of file fmtfld.hxx.

Referenced by SetXTextField(), and UpdateTextNode().

mpField

std::unique_ptr<SwField> SwFormatField::mpField

private

Definition at line 108 of file fmtfld.hxx.

Referenced by dumpAsXml(), operator==(), SetField(), SwClientNotify(), SwFormatField(), UpdateTextNode(), and ~SwFormatField().

mpTextField

SwTextField* SwFormatField::mpTextField

private

Definition at line 109 of file fmtfld.hxx.

Referenced by ClearTextField(), dumpAsXml(), GetInfo(), IsFieldInDoc(), IsProtect(), SetTextField(), SwClientNotify(), and UpdateTextNode().

---

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

• fmtfld.hxx
• atrfld.cxx