SwFieldType Class Reference

Instances of SwFields and those derived from it occur 0 to n times. More...

#include <fldbas.hxx>

Inheritance diagram for SwFieldType:

Collaboration diagram for SwFieldType:

Public Member Functions
SAL_DLLPRIVATE css::uno::WeakReference< css::beans::XPropertySet > const &	GetXObject () const
SAL_DLLPRIVATE void	SetXObject (css::uno::Reference< css::beans::XPropertySet > const &xFieldMaster)
virtual OUString	GetName () const
	Only in derived classes. More...
virtual std::unique_ptr< SwFieldType >	Copy () const =0
virtual void	QueryValue (css::uno::Any &rVal, sal_uInt16 nWhich) const
virtual void	PutValue (const css::uno::Any &rVal, sal_uInt16 nWhich)
SwFieldIds	Which () const
void	UpdateFields () const
virtual void	dumpAsXml (xmlTextWriterPtr pWriter) const
Public Member Functions inherited from SwModify
	SwModify ()
	SwModify (SwModify *pToRegisterIn)
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)
SwClient *	Remove (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 ()
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::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 ()

Static Public Member Functions
static OUString	GetTypeStr (sal_uInt16 nTypeId)

Protected Member Functions
	SwFieldType (SwFieldIds nWhichId)
	Single argument ctors shall be explicit. More...
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

Static Private Member Functions
static void	GetFieldName_ ()
	Sets up FieldNames; fldmgr.cxx! More...

Private Attributes
css::uno::WeakReference< css::beans::XPropertySet >	m_wXFieldMaster
SwFieldIds const	m_nWhich

Static Private Attributes
static std::vector< OUString > *	s_pFieldNames = nullptr
	field names More...

Friends
void	FinitUI ()
	In order to delete pointer! More...

Detailed Description

Instances of SwFields and those derived from it occur 0 to n times.

For each class there is one instance of the associated type class. Base class of all field types is SwFieldType.

Definition at line 233 of file fldbas.hxx.

Constructor & Destructor Documentation

SwFieldType::SwFieldType ( SwFieldIds  nWhichId )

explicitprotected

Single argument ctors shall be explicit.

Definition at line 139 of file fldbas.cxx.

Member Function Documentation

virtual std::unique_ptr<SwFieldType> SwFieldType::Copy ( ) const

pure virtual

Implemented in SwCombinedCharFieldType, SwScriptFieldType, SwJumpEditFieldType, SwRefPageGetFieldType, SwRefPageSetFieldType, SwExtUserFieldType, SwDocInfoFieldType, SwPostItFieldType, SwMacroFieldType, SwTableFieldType, SwHiddenParaFieldType, SwHiddenTextFieldType, SwInputFieldType, SwDBSetNumberFieldType, SwDocStatFieldType, SwDBNameFieldType, SwTemplNameFieldType, SwFileNameFieldType, SwDBNumSetFieldType, SwAuthorFieldType, SwSetExpFieldType, SwDBNextSetFieldType, SwPageNumberFieldType, SwAuthorityFieldType, SwGetExpFieldType, SwDDEFieldType, SwGetRefFieldType, SwUserFieldType, SwDropDownFieldType, SwChapterFieldType, SwDBFieldType, and SwDateTimeFieldType.

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

void SwFieldType::dumpAsXml ( xmlTextWriterPtr  pWriter ) const

virtual

Reimplemented in SwUserFieldType.

Definition at line 157 of file fldbas.cxx.

References SwIterator< TElementType, TSource, eMode >::First(), and SwIterator< TElementType, TSource, eMode >::Next().

Referenced by SwUserFieldType::dumpAsXml().

void SwFieldType::GetFieldName_ ( )

staticprivate

Sets up FieldNames; fldmgr.cxx!

Definition at line 1725 of file fldmgr.cxx.

References MnemonicGenerator::EraseAllMnemonicChars(), s_pFieldNames, SAL_N_ELEMENTS, and SwResId().

OUString SwFieldType::GetName ( ) const

virtual

Only in derived classes.

Reimplemented in SwSetExpFieldType, SwDDEFieldType, SwUserFieldType, and SwDBFieldType.

Definition at line 145 of file fldbas.cxx.

Referenced by SwXTextField::attachTextFieldMaster(), SwSetExpField::ExpandImpl(), sw::DocumentFieldsManager::FieldsToExpand(), SwGetRefField::GetFieldName(), SwUserField::GetFieldName(), SwInputField::GetFieldName(), SwTableField::GetFieldName(), SwMacroField::GetFieldName(), sw::DocumentFieldsManager::GetFieldType(), SwAccessibleParagraph::GetFieldTypeNameAtIndex(), SwXTextFieldMasters::getInstanceName(), SwXFieldMaster::GetProgrammaticName(), SwFieldMgr::GetSubTypes(), sw::DocumentFieldsManager::InsDeletedFieldType(), SwView::InsertCaption(), sw::DocumentFieldsManager::InsertFieldType(), SwXFieldMaster::LocalizeFormula(), SwGetRefFieldType::MergeWithOtherDoc(), OutHTML_SwFormatField(), SwTransferable::PasteDDE(), SwEditShell::RemoveFieldType(), SwTOXSelectTabPage::Reset(), SwXFieldMaster::setPropertyValue(), SwCaptionDialog::SwCaptionDialog(), SwCaptionOptPage::SwCaptionOptPage(), AttributeOutputBase::TextField(), SwCaptionOptPage::UpdateEntry(), sw::DocumentFieldsManager::UpdateExpFieldsImpl(), and RtfAttributeOutput::WriteExpand().

OUString SwFieldType::GetTypeStr ( sal_uInt16  nTypeId )

static

Definition at line 128 of file fldbas.cxx.

References s_pFieldNames, and size.

Referenced by SwFieldDokPage::AddSubType(), SwDBManager::FillCalcWithMergeData(), SwUserField::GetFieldName(), SwGetExpField::GetFieldName(), SwSetExpField::GetFieldName(), SwHiddenTextField::GetFieldName(), SwField::GetFieldName(), SwDocInfoField::GetFieldName(), SwAccessibleParagraph::GetFieldTypeNameAtIndex(), SwFieldMgr::GetTypeStr(), sw::DocumentFieldsManager::UpdateExpFieldsImpl(), and SwCalc::VarLook().

SAL_DLLPRIVATE css::uno::WeakReference<css::beans::XPropertySet> const& SwFieldType::GetXObject ( ) const

inline

Definition at line 250 of file fldbas.hxx.

Referenced by SwXFieldMaster::CreateXFieldMaster().

void SwFieldType::PutValue ( const css::uno::Any &  rVal, sal_uInt16  nWhich  )

virtual

Reimplemented in SwSetExpFieldType, SwAuthorityFieldType, SwDDEFieldType, SwUserFieldType, and SwDBFieldType.

Definition at line 153 of file fldbas.cxx.

Referenced by SwXFieldMaster::setPropertyValue().

void SwFieldType::QueryValue ( css::uno::Any &  rVal, sal_uInt16  nWhich  ) const

virtual

Reimplemented in SwSetExpFieldType, SwAuthorityFieldType, SwDDEFieldType, SwUserFieldType, and SwDBFieldType.

Definition at line 150 of file fldbas.cxx.

Referenced by SwXFieldMaster::getPropertyValue().

SAL_DLLPRIVATE void SwFieldType::SetXObject ( css::uno::Reference< css::beans::XPropertySet > const &  xFieldMaster )

inline

Definition at line 253 of file fldbas.hxx.

Referenced by SwXFieldMaster::CreateXFieldMaster().

void SwFieldType::UpdateFields ( ) const

inline

Definition at line 271 of file fldbas.hxx.

References SwClient::ModifyNotification().

Referenced by SwFieldInputDlg::Apply(), SwInputField::applyFieldContent(), SwDoc::ChgDBData(), SwWrtShell::ClickToField(), sw::DocumentStatisticsManager::DocInfoChgd(), IMPL_LINK(), sw::DocumentStatisticsManager::IncrementalDocStatCalculate(), SwUserFieldType::Modify(), SwHiddenTextFieldType::SetHiddenFlag(), SwXFieldMaster::setPropertyValue(), SwFieldMgr::UpdateCurField(), sw::DocumentFieldsManager::UpdateField(), sw::UpdateFieldsForRedline(), SwWrtShell::UpdateInputFields(), SwTOXMgr::UpdateOrInsertTOX(), and SwNodes::UpdateOutlineNode().

SwFieldIds SwFieldType::Which ( ) const

inline

Definition at line 265 of file fldbas.hxx.

Referenced by SwXTextField::attachTextFieldMaster(), SwInputFieldList::BuildSortLst(), SwpHints::CalcFlags(), SwpHints::CalcHiddenParaField(), SwDoc::ChangeAuthorityData(), SwDoc::ChangeDBFields(), SwNodes::ChgNode(), SwField::ChgTyp(), SwWrtShell::ClickToField(), SwDoc::ConvertFieldsToText(), SwTextField::CopyTextField(), SwpHints::DeleteAtPos(), SwTextNode::DestroyAttr(), sw::DropDownFieldDialog::DropDownFieldDialog(), SwTextShell::ExecField(), SwTextField::ExpandTextField(), SwDoc::FieldHidesPara(), sw::DocumentFieldsManager::FieldsToExpand(), AttributeOutputBase::GenerateBookmarksForSequenceField(), SwDoc::GetAllUsedDB(), SwCursorShell::GetCurField(), SwDoc::GetDBDesc(), sw::DocumentFieldsManager::GetFieldType(), GetFieldTypeMId(), SwAccessibleParagraph::GetFieldTypeNameAtIndex(), SwTextShell::GetIdxState(), SwXTextFieldMasters::getInstanceName(), SwXFieldMaster::GetProgrammaticName(), sw::DocumentFieldsManager::GetRecordsPerDocument(), SwFieldMgr::GetSubTypes(), SwField::GetTypeId(), SwTableBox::GetValue(), SwFieldMgr::GoNextPrev(), SwField::HasClickHdl(), SwAuthorMarkPane::InitControls(), sw::DocumentFieldsManager::InsDeletedFieldType(), SwDocUpdateField::InsDelFieldInFieldLst(), SwWrtShell::Insert(), SwView::InsertCaption(), sw::DocumentFieldsManager::InsertFieldType(), SwDocUpdateField::InsertFieldType(), SwTextNode::InsertHint(), SwWrtShell::InsertPostIt(), SwField::IsFixed(), SwTextFrame::IsHiddenNow(), lcl_CopyHint(), SwDocUpdateField::MakeFieldList_(), SwCursorShell::MoveFieldType(), SwTextFormatter::NewFieldPortion(), IsPostitField::operator()(), IsPostitFieldWithAuthorOf::operator()(), IsPostitFieldWithPostitId::operator()(), OutHTML_SwField(), OutHTML_SwFormatField(), WW8Export::OutputField(), SwTransferable::PasteDDE(), DocxAttributeOutput::RefField(), sw::DocumentFieldsManager::RemoveFieldType(), SwDocUpdateField::RemoveFieldType(), SwEditShell::RemoveFieldType(), SwTOXSelectTabPage::Reset(), SwXFieldMaster::setPropertyValue(), SwTextShell::StateField(), SwCaptionDialog::SwCaptionDialog(), SwFieldInputDlg::SwFieldInputDlg(), SwInputFieldList::SwInputFieldList(), SwJavaEditDialog::SwJavaEditDialog(), AttributeOutputBase::TextField(), SwpHints::TryInsertHint(), SwCaptionOptPage::UpdateEntry(), sw::DocumentFieldsManager::UpdateExpFieldsImpl(), sw::DocumentFieldsManager::UpdateField(), SwWrtShell::UpdateInputFields(), SwEditShell::UpdateOneField(), sw::DocumentFieldsManager::UpdatePageFields(), sw::DocumentFieldsManager::UpdateUsrFields(), SwCalc::VarLook(), SwField::Which(), RtfAttributeOutput::WriteExpand(), DocxAttributeOutput::WriteField_Impl(), and SwFormatField::~SwFormatField().

Friends And Related Function Documentation

void FinitUI ( )

friend

In order to delete pointer!

Definition at line 72 of file initui.cxx.

Member Data Documentation

SwFieldIds const SwFieldType::m_nWhich

private

Definition at line 237 of file fldbas.hxx.

css::uno::WeakReference<css::beans::XPropertySet> SwFieldType::m_wXFieldMaster

private

Definition at line 235 of file fldbas.hxx.

std::vector< OUString > * SwFieldType::s_pFieldNames = nullptr

staticprivate

field names

Definition at line 240 of file fldbas.hxx.

Referenced by FinitUI(), GetFieldName_(), and GetTypeStr().

---

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

• fldbas.hxx
• fldbas.cxx
• fldmgr.cxx