The shared part of a user field. More...

#include <usrfld.hxx>

Inheritance diagram for SwUserFieldType:

Collaboration diagram for SwUserFieldType:

Public Member Functions
	SwUserFieldType (SwDoc *pDocPtr, const OUString &)

virtual OUString	GetName () const override
	Only in derived classes. More...

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

OUString	Expand (sal_uInt32 nFormat, sal_uInt16 nSubType, LanguageType nLng)

OUString	GetContent (sal_uInt32 nFormat=0)

void	SetContent (const OUString &rStr, sal_uInt32 nFormat=0)

bool	IsValid () const

double	GetValue (SwCalc &rCalc)

double	GetValue () const

void	SetValue (const double nVal)

sal_uInt16	GetType () const

void	SetType (sal_uInt16)

bool	IsDeleted () const

void	SetDeleted (bool b)

virtual void	QueryValue (css::uno::Any &rVal, sal_uInt16 nMId) const override

virtual void	PutValue (const css::uno::Any &rVal, sal_uInt16 nMId) override

void	dumpAsXml (xmlTextWriterPtr pWriter) const override

Public Member Functions inherited from SwValueFieldType
SwDoc *	GetDoc () const

void	SetDoc (SwDoc *pNewDoc)

bool	UseFormat () const

void	EnableFormat (bool bFormat=true)

OUString	ExpandValue (const double &rVal, sal_uInt32 nFormat, LanguageType nLng) const
	return value formatted as string More...

OUString	DoubleToString (const double &rVal, LanguageType eLng) const

OUString	DoubleToString (const double &rVal, sal_uInt32 nFormat) const

Public Member Functions inherited from SwFieldType
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	PrintHiddenPara ()

virtual void	dumpAsXml (xmlTextWriterPtr pWriter) const

SwFormatField *	FindFormatForField (const SwField *) const

SwFormatField *	FindFormatForPostItId (sal_uInt32 nPostItId) const

void	CollectPostIts (std::vector< SwFormatField * > &rvFormatFields, IDocumentRedlineAccess const &rIDRA, bool HideRedlines)

bool	HasHiddenInformationNotes () const

void	GatherNodeIndex (std::vector< SwNodeOffset > &rvNodeIndex)

void	GatherRefFields (std::vector< SwGetRefField * > &rvRFields, const sal_uInt16 nTyp)

void	GatherFields (std::vector< SwFormatField * > &rvFormatFields, bool bCollectOnlyInDocNodes=true) const

void	GatherDdeTables (std::vector< SwDDETable * > &rvTables) const

virtual void	UpdateFields ()

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

Public Member Functions inherited from sw::BroadcasterMixin
	BroadcasterMixin ()=default

	BroadcasterMixin (BroadcasterMixin const &)=default

BroadcasterMixin &	operator= (const BroadcasterMixin &)

SvtBroadcaster &	GetNotifier ()

Private Member Functions
virtual void	SwClientNotify (const SwModify &, const SfxHint &) override

Private Attributes
bool	m_bValidValue: 1

bool	m_bDeleted: 1

double	m_nValue
	Float value type. More...

OUString	m_aName

OUString	m_aContent
	String value type. More...

OUString	m_aContentLang
	Language used by m_aContents. More...

sal_uInt16	m_nType

Additional Inherited Members
Static Public Member Functions inherited from SwFieldType
static const OUString &	GetTypeStr (SwFieldTypesEnum nTypeId)

Protected Member Functions inherited from SwValueFieldType
	SwValueFieldType (SwDoc *pDocPtr, SwFieldIds nWhichId)

	SwValueFieldType (const SwValueFieldType &rTyp)

Protected Member Functions inherited from SwFieldType
	SwFieldType (SwFieldIds nWhichId)
	Single argument ctors shall be explicit. More...

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

Detailed Description

The shared part of a user field.

Tracks the value, but conversion between the float and string representation always happens with the system locale.

Definition at line 34 of file usrfld.hxx.

Constructor & Destructor Documentation

◆ SwUserFieldType()

SwUserFieldType::SwUserFieldType	(	SwDoc *	pDocPtr,
		const OUString &	aNam
	)

Definition at line 176 of file usrfld.cxx.

References SwValueFieldType::EnableFormat(), m_aName, m_bDeleted, and m_bValidValue.

Referenced by Copy().

Member Function Documentation

◆ Copy()

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

overridevirtual

Implements SwFieldType.

Definition at line 199 of file usrfld.cxx.

References SwValueFieldType::GetDoc(), m_aContent, m_aContentLang, m_aName, m_bDeleted, m_bValidValue, m_nType, m_nValue, and SwUserFieldType().

◆ dumpAsXml()

void SwUserFieldType::dumpAsXml ( xmlTextWriterPtr pWriter ) const

overridevirtual

Reimplemented from SwFieldType.

Definition at line 374 of file usrfld.cxx.

References SwFieldType::dumpAsXml(), m_aContent, m_aContentLang, and m_nValue.

◆ Expand()

OUString SwUserFieldType::Expand	(	sal_uInt32	nFormat,
		sal_uInt16	nSubType,
		LanguageType	nLng
	)

Definition at line 187 of file usrfld.cxx.

References SwValueFieldType::EnableFormat(), SwValueFieldType::ExpandValue(), nsSwGetSetExpType::GSE_EXPR, m_aContent, m_nType, m_nValue, and nsSwExtendedSubType::SUB_CMD.

◆ GetContent()

OUString SwUserFieldType::GetContent ( sal_uInt32 nFormat = 0 )

Definition at line 278 of file usrfld.cxx.

References SwValueFieldType::GetDoc(), SwDoc::GetNumberFormatter(), SvNumberFormatter::GetOutputString(), GetValue(), m_aContent, and SAL_MAX_UINT32.

Referenced by SwFieldInputDlg::Apply(), SwInputField::ExpandImpl(), SwFieldMgr::InsertField(), SwFieldVarPage::SubTypeHdl(), SwFieldInputDlg::SwFieldInputDlg(), and SwCalc::VarLook().

◆ GetName()

OUString SwUserFieldType::GetName ( ) const

overridevirtual

Only in derived classes.

Reimplemented from SwFieldType.

Definition at line 212 of file usrfld.cxx.

References m_aName.

Referenced by SwFieldVarPage::SubTypeHdl().

◆ GetType()

sal_uInt16 SwUserFieldType::GetType ( ) const

inline

Definition at line 87 of file usrfld.hxx.

References m_nType.

Referenced by SwXTextField::attach(), SwFieldVarPage::SubTypeHdl(), and SwCalc::VarLook().

◆ GetValue() [1/2]

double SwUserFieldType::GetValue ( ) const

inline

Definition at line 81 of file usrfld.hxx.

References m_nValue.

Referenced by GetContent().

◆ GetValue() [2/2]

double SwUserFieldType::GetValue ( SwCalc & rCalc )

Definition at line 236 of file usrfld.cxx.

References SwCalc::Calculate(), LanguageTag::getBcp47(), SwCalc::GetCharClass(), SwSbxValue::GetDouble(), CharClass::getLanguageTag(), SwCalc::IsCalcError(), m_aContent, m_aContentLang, m_bValidValue, m_nValue, SwCalc::Pop(), SwCalc::Push(), SwCalc::SetCalcError(), SwCalc::SetCharClass(), and Syntax.

Referenced by SwFormatField::UpdateTextNode(), sw::DocumentFieldsManager::UpdateUsrFields(), and SwCalc::VarLook().

◆ IsDeleted()

bool SwUserFieldType::IsDeleted ( ) const

inline

Definition at line 67 of file usrfld.hxx.

◆ IsValid()

bool SwUserFieldType::IsValid ( ) const

inline

Definition at line 78 of file usrfld.hxx.

References m_bValidValue.

Referenced by SwFormatField::UpdateTextNode(), and SwCalc::VarLook().

◆ PutValue()

void SwUserFieldType::PutValue	(	const css::uno::Any &	rVal,
		sal_uInt16	nMId
	)

overridevirtual

Reimplemented from SwFieldType.

Definition at line 340 of file usrfld.cxx.

References SwValueFieldType::DoubleToString(), FIELD_PROP_BOOL1, FIELD_PROP_DOUBLE, FIELD_PROP_PAR2, LanguageTag::getBcp47(), nsSwGetSetExpType::GSE_EXPR, nsSwGetSetExpType::GSE_STRING, m_aContent, m_aContentLang, m_nType, and m_nValue.

◆ QueryValue()

void SwUserFieldType::QueryValue	(	css::uno::Any &	rVal,
		sal_uInt16	nMId
	)		const

overridevirtual

Reimplemented from SwFieldType.

Definition at line 322 of file usrfld.cxx.

References FIELD_PROP_BOOL1, FIELD_PROP_DOUBLE, FIELD_PROP_PAR2, nsSwGetSetExpType::GSE_EXPR, m_aContent, m_nType, and m_nValue.

◆ SetContent()

void SwUserFieldType::SetContent	(	const OUString &	rStr,
		sal_uInt32	nFormat = `0`
	)

Definition at line 294 of file usrfld.cxx.

References SwValueFieldType::DoubleToString(), LanguageTag::getBcp47(), SwValueFieldType::GetDoc(), SwDoc::getIDocumentState(), SwDoc::GetIDocumentUndoRedo(), IDocumentState::IsModified(), m_aContent, m_aContentLang, SAL_MAX_UINT32, IDocumentState::SetModified(), IDocumentUndoRedo::SetUndoNoResetModified(), and SetValue().

Referenced by SwFieldInputDlg::Apply(), SwInputField::applyFieldContent(), IMPL_LINK(), and SwFieldMgr::InsertField().

◆ SetDeleted()

void SwUserFieldType::SetDeleted ( bool b )

inline

Definition at line 68 of file usrfld.hxx.

◆ SetType()

void SwUserFieldType::SetType ( sal_uInt16 nSub )

inline

Definition at line 90 of file usrfld.hxx.

References SwValueFieldType::EnableFormat(), nsSwGetSetExpType::GSE_STRING, and m_nType.

Referenced by IMPL_LINK().

◆ SetValue()

void SwUserFieldType::SetValue ( const double nVal )

inline

Definition at line 84 of file usrfld.hxx.

References m_nValue.

Referenced by SetContent().

◆ SwClientNotify()

void SwUserFieldType::SwClientNotify	(	const SwModify &	,
		const SfxHint &	rHint
	)

overrideprivatevirtual

Reimplemented from SwModify.

Definition at line 217 of file usrfld.cxx.

References sw::BroadcastingModify::CallSwClientNotify(), SwValueFieldType::GetDoc(), SfxHint::GetId(), SwDoc::getIDocumentFieldsAccess(), IDocumentFieldsAccess::GetSysFieldType(), Input, SwModify::IsModifyLocked(), SwModify::LockModify(), m_bValidValue, SwModify::UnlockModify(), and SwFieldType::UpdateFields().

Member Data Documentation

◆ m_aContent

OUString SwUserFieldType::m_aContent

private

String value type.

Definition at line 42 of file usrfld.hxx.

Referenced by Copy(), dumpAsXml(), Expand(), GetContent(), GetValue(), PutValue(), QueryValue(), and SetContent().

◆ m_aContentLang

OUString SwUserFieldType::m_aContentLang

private

Language used by m_aContents.

Definition at line 44 of file usrfld.hxx.

Referenced by Copy(), dumpAsXml(), GetValue(), PutValue(), and SetContent().

◆ m_aName

OUString SwUserFieldType::m_aName

private

Definition at line 40 of file usrfld.hxx.

Referenced by Copy(), GetName(), and SwUserFieldType().

◆ m_bDeleted

bool SwUserFieldType::m_bDeleted

private

Definition at line 37 of file usrfld.hxx.

Referenced by Copy(), and SwUserFieldType().

◆ m_bValidValue

bool SwUserFieldType::m_bValidValue

private

Definition at line 36 of file usrfld.hxx.

Referenced by Copy(), GetValue(), IsValid(), SwClientNotify(), and SwUserFieldType().

◆ m_nType

sal_uInt16 SwUserFieldType::m_nType

private

Definition at line 45 of file usrfld.hxx.

Referenced by Copy(), Expand(), GetType(), PutValue(), QueryValue(), and SetType().

◆ m_nValue

double SwUserFieldType::m_nValue

private

Float value type.

Definition at line 39 of file usrfld.hxx.

Referenced by Copy(), dumpAsXml(), Expand(), GetValue(), PutValue(), QueryValue(), and SetValue().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SwUserFieldType()

Member Function Documentation

◆ Copy()

◆ dumpAsXml()

◆ Expand()

◆ GetContent()

◆ GetName()

◆ GetType()

◆ GetValue() [1/2]

◆ GetValue() [2/2]

◆ IsDeleted()

◆ IsValid()

◆ PutValue()

◆ QueryValue()

◆ SetContent()

◆ SetDeleted()

◆ SetType()

◆ SetValue()

◆ SwClientNotify()

Member Data Documentation

◆ m_aContent

◆ m_aContentLang

◆ m_aName

◆ m_bDeleted

◆ m_bValidValue

◆ m_nType

◆ m_nValue