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 css::uno::WeakReference< css::text::XTextField > const &	GetXTextField () const
SAL_DLLPRIVATE void	SetXTextField (css::uno::Reference< css::text::XTextField > const &xTextField)
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
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< SfxPoolItem >	CloneSetWhich (sal_uInt16 nNewWhich) const
std::unique_ptr< T >	CloneSetWhich (TypedWhichId< T > nId) const
sal_uInt32	GetRefCount () const
SfxItemKind	GetKind () 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 ()
void	NotifyClients (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
void	ModifyBroadcast (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
virtual	~SwModify () override
void	Add (SwClient *pDepend)
SwClient *	Remove (SwClient *pDepend)
bool	HasWriterListeners () const
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
std::unique_ptr< sw::ModifyChangedHint >	CheckRegistration (const SfxPoolItem *pOldValue)
virtual void	ModifyNotification (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
void	SwClientNotifyCall (const SwModify &rModify, const SfxHint &rHint)
const SwModify *	GetRegisteredIn () const
SwModify *	GetRegisteredIn ()
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
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	Modify (const SfxPoolItem *pOld, const SfxPoolItem *pNew) override
virtual void	SwClientNotify (const SwModify &rModify, const SfxHint &rHint) override

Private Attributes
css::uno::WeakReference< css::text::XTextField >	m_wXTextField
std::unique_ptr< SwField >	mpField
SwTextField *	mpTextField

Friends
void	InitCore ()

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

Detailed Description

Definition at line 37 of file fmtfld.hxx.

Constructor & Destructor Documentation

SwFormatField::SwFormatField ( sal_uInt16  nWhich )

private

Definition at line 48 of file atrfld.cxx.

Referenced by Clone().

SwFormatField::SwFormatField ( const SwField &  rField )

explicit

Single argument constructors shall be explicit.

Definition at line 55 of file atrfld.cxx.

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

SwFormatField::SwFormatField

(

const SwFormatField &

rAttr

)

Definition at line 93 of file atrfld.cxx.

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

SwFormatField::~SwFormatField ( )

overridevirtual

Definition at line 131 of file atrfld.cxx.

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

Member Function Documentation

void SwFormatField::ClearTextField

(

)

Definition at line 195 of file atrfld.cxx.

References mpTextField.

Referenced by SwTextField::~SwTextField().

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

overridevirtual

Implements SfxPoolItem.

Definition at line 211 of file atrfld.cxx.

References SwFormatField().

Referenced by SwWW8FltRefStack::RefToVar().

void SwFormatField::dumpAsXml ( xmlTextWriterPtr  pWriter ) const

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 342 of file atrfld.cxx.

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

Referenced by SwTextAttr::dumpAsXml().

const SwField* SwFormatField::GetField ( ) const

inline

Definition at line 70 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(), SwTOXAuthority::equivalent(), SwTextShell::ExecField(), SwTextField::ExpandTextField(), sw::DocumentFieldsManager::FieldsToExpand(), SwTOXAuthority::FillText(), AttributeOutputBase::GenerateBookmarksForSequenceField(), SwDoc::GetAllUsedDB(), SwTextAnnotationField::GetAnnotationMark(), SwDocUpdateField::GetBodyNode(), SwCursorShell::GetContentAtPos(), SwPageFrame::GetCursorOfst(), SwInputFieldList::GetField(), SwCursorShell::GetFieldAtCursor(), sw::DocumentFieldsManager::GetFieldAtPos(), SwTextInputField::GetFieldContent(), SwXTextField::Impl::GetFieldType(), SwAccessibleParagraph::GetFieldTypeNameAtIndex(), SwTOXAuthority::GetLevel(), SwTextNode::GetMinMaxSize(), SwCursorShell::GetPostItFieldAtCursor(), sw::DocumentFieldsManager::GetRecordsPerDocument(), SwTextFrame::GetScalingOfSelectedText(), SwAuthorityFieldType::GetSequencePos(), SwTableBox::GetValue(), sw::mark::AnnotationMark::InitDoc(), SwDocUpdateField::InsDelFieldInFieldLst(), SwTextNode::InsertHint(), SwWrtShell::InsertPostIt(), SwEditShell::IsFieldDataSourceAvailable(), SwWW8FltRefStack::IsFootnoteEdnBkmField(), SwTextFrame::IsHiddenNow(), sw::annotation::SwAnnotationWin::IsResolved(), SwTableBox::IsValidNumTextNd(), lcl_CopyHint(), lcl_ExportHints(), lcl_GetText(), lcl_IsNoEndTextAttrAtPos(), lcl_MakeFieldLst(), SwDocUpdateField::MakeFieldList_(), MakeTextAttr(), SwEditWin::MouseButtonDown(), SwTextFormatter::NewFieldPortion(), SwPostItMgr::Notify(), OutHTML_SwFormatField(), SwDBFieldType::PutValue(), SwDBField::PutValue(), SwFltControlStack::SetAttrInDoc(), SwWW8FltRefStack::SetAttrInDoc(), sw::annotation::SwAnnotationWin::SetPostItText(), sw::annotation::SwAnnotationWin::SetResolved(), SwTOXAuthority::sort_lt(), AttributeOutputBase::TextField(), SwXTextField::TransmuteLeadToInputField(), SwpHints::TryInsertHint(), SwUndoFieldFromDoc::UndoImpl(), sw::DocumentFieldsManager::UpdateExpFieldsImpl(), sw::DocumentFieldsManager::UpdateField(), SwRefPageGetFieldType::UpdateField(), SwTextInputField::UpdateFieldContent(), SwEditShell::UpdateOneField(), SwEditWin::UpdatePointer(), and SwHandleAnchorNodeChg::~SwHandleAnchorNodeChg().

SwField* SwFormatField::GetField ( )

inline

Definition at line 74 of file fmtfld.hxx.

bool SwFormatField::GetInfo ( SfxPoolItem &  rInfo ) const

overridevirtual

Reimplemented from SwModify.

Definition at line 321 of file atrfld.cxx.

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

const SwTextField* SwFormatField::GetTextField ( ) const

inline

Definition at line 88 of file fmtfld.hxx.

Referenced by SwPostItMgr::AddPostIts(), SwInputField::applyFieldContent(), sw::annotation::SwAnnotationWin::CalcParent(), SwPostItMgr::CalcRects(), SwDoc::ChangeDBFields(), SwTextField::CopyTextField(), sw::annotation::SwAnnotationWin::CountFollowing(), SwXFieldMaster::dispose(), SwDoc::GetAllUsedDB(), SwAnnotationItem::GetAnchorPosition(), SwDocShell::GetHiddenInformationState(), SwGetExpField::GetReferenceTextPos(), SwCursorShell::GotoFormatField(), sw::annotation::SwAnnotationWin::InitAnswer(), sw::sidebarwindows::SwFrameSidebarWinContainer::insert(), SwViewShell::IsAnyFieldInDoc(), SwDocUpdateField::MakeFieldList_(), OutHTML_SwFormatField(), SwDBFieldType::PutValue(), SwDBField::PutValue(), SwTextFrame::SwClientNotify(), SwTOXAuthority::SwTOXAuthority(), SwXFieldEnumeration::SwXFieldEnumeration(), AttributeOutputBase::TextField(), SwXTextField::TransmuteLeadToInputField(), sw::annotation::SwAnnotationWin::UpdateData(), SwAnnotationItem::UseElement(), and SwTextField::~SwTextField().

SwTextField* SwFormatField::GetTextField ( )

inline

Definition at line 92 of file fmtfld.hxx.

SAL_DLLPRIVATE css::uno::WeakReference<css::text::XTextField> const& SwFormatField::GetXTextField ( ) const

inline

Definition at line 103 of file fmtfld.hxx.

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

void SwFormatField::InvalidateField

(

)

Definition at line 216 of file atrfld.cxx.

References SwModify::NotifyClients(), and RES_REMOVE_UNO_OBJECT.

bool SwFormatField::IsFieldInDoc

(

)

const

Definition at line 329 of file atrfld.cxx.

References SwTextField::IsFieldInDoc(), and mpTextField.

Referenced by SwPostItMgr::AddPostIts(), SwNodes::ChgNode(), SwDocShell::GetHiddenInformationState(), SwXFieldMaster::getPropertyValue(), SwEditShell::IsAnyDatabaseFieldInDoc(), SwEditShell::IsFieldDataSourceAvailable(), SwPostItMgr::Notify(), and SwAnnotationItem::UseElement().

bool SwFormatField::IsProtect

(

)

const

Definition at line 335 of file atrfld.cxx.

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

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

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

overrideprivatevirtual

Reimplemented from SwModify.

Definition at line 247 of file atrfld.cxx.

References DatabaseName, DbNextSet, DbNumSet, DbSetNumber, SwTextField::ExpandTextField(), SwNode::GetDoc(), GetRef, SwTextField::GetTextNode(), SwUserFieldType::GetValue(), HiddenPara, SwUserFieldType::IsValid(), m_wXTextField, SwContentNode::ModifyNotification(), mpField, mpTextField, SwModify::NotifyClients(), RES_ATTRSET_CHG, RES_DOCPOS_UPDATE, RES_FMT_CHG, RES_HIDDENPARA_PRINT, RES_OBJECTDYING, RES_REFMARKFLD_UPDATE, RES_REMOVE_UNO_OBJECT, User, and SfxPoolItem::Which().

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

overridevirtual

"Pure virtual methods" of SfxPoolItem.

Implements SfxPoolItem.

Definition at line 200 of file atrfld.cxx.

References mpField.

void SwFormatField::RegisterToFieldType

(

SwFieldType &

rType

)

Definition at line 170 of file atrfld.cxx.

References SwModify::Add().

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

void SwFormatField::SetField

(

std::unique_ptr< SwField >

pField

)

Sets current field.

Parameters

pField

new field

Attention:

The current field will be destroyed before setting the new field.

Definition at line 175 of file atrfld.cxx.

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

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

void SwFormatField::SetTextField

(

SwTextField &

rTextField

)

Definition at line 190 of file atrfld.cxx.

References mpTextField.

Referenced by SwTextField::SwTextField().

SAL_DLLPRIVATE void SwFormatField::SetXTextField ( css::uno::Reference< css::text::XTextField > const &  xTextField )

inline

Definition at line 105 of file fmtfld.hxx.

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

overrideprivatevirtual

Reimplemented from SwClient.

Definition at line 223 of file atrfld.cxx.

References SwIndex::Assign(), IDocumentContentOperations::DeleteRange(), fnMoveForward, SwPaM::GetDoc(), SwDoc::getIDocumentContentOperations(), SwPaM::GetPoint(), SwTextAttr::GetStart(), SwTextField::GetTextNode(), IDocumentContentOperations::InsertString(), SwDoc::IsClipBoard(), SwFieldHint::m_pLayout, SwFieldHint::m_pPaM, SwPaM::Move(), mpField, mpTextField, SwPosition::nContent, SwPosition::nNode, SwPaM::SetMark(), and SwClient::SwClientNotify().

Friends And Related Function Documentation

void InitCore ( )

friend

Definition at line 455 of file init.cxx.

Member Data Documentation

css::uno::WeakReference<css::text::XTextField> SwFormatField::m_wXTextField

private

Definition at line 45 of file fmtfld.hxx.

Referenced by Modify().

std::unique_ptr<SwField> SwFormatField::mpField

private

Definition at line 47 of file fmtfld.hxx.

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

SwTextField* SwFormatField::mpTextField

private

Definition at line 48 of file fmtfld.hxx.

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

---

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

• fmtfld.hxx
• atrfld.cxx