SwExtUserField Class Reference

#include <docufld.hxx>

Inheritance diagram for SwExtUserField:

Collaboration diagram for SwExtUserField:

Public Member Functions
	SwExtUserField (SwExtUserFieldType *, sal_uInt16 nSub, sal_uInt32 nFormat)
virtual OUString	ExpandImpl (SwRootFrame const *pLayout) const override
virtual std::unique_ptr< SwField >	Copy () const override
virtual sal_uInt16	GetSubType () const override
virtual void	SetSubType (sal_uInt16 nSub) override
void	SetExpansion (const OUString &rStr)
virtual bool	QueryValue (css::uno::Any &rVal, sal_uInt16 nWhich) const override
virtual bool	PutValue (const css::uno::Any &rVal, sal_uInt16 nWhich) override
Public Member Functions inherited from SwField
virtual	~SwField ()
	SwField (SwField const &)=default
	SwField (SwField &&)=default
SwField &	operator= (SwField const &)=default
SwField &	operator= (SwField &&)=default
SwFieldType *	GetTyp () const
virtual SwFieldType *	ChgTyp (SwFieldType *)
	Set new type (used for copying among documents). More...
OUString	ExpandField (bool bCached, SwRootFrame const *pLayout) const
	expand the field. More...
virtual OUString	GetFieldName () const
	get name or content More...
std::unique_ptr< SwField >	CopyField () const
SwFieldIds	Which () const
	ResId. More...
SwFieldTypesEnum	GetTypeId () const
virtual sal_uInt16	GetSubType () const
virtual void	SetSubType (sal_uInt16)
LanguageType	GetLanguage () const
	Language at field position. More...
virtual void	SetLanguage (LanguageType nLng)
sal_uInt32	GetFormat () const
	Query parameters for dialog and for BASIC. More...
virtual OUString	GetPar1 () const
virtual OUString	GetPar2 () const
virtual OUString	GetFormula () const
void	ChangeFormat (sal_uInt32 n)
virtual void	SetPar1 (const OUString &rStr)
virtual void	SetPar2 (const OUString &rStr)
virtual bool	QueryValue (css::uno::Any &rVal, sal_uInt16 nWhichId) const
virtual bool	PutValue (const css::uno::Any &rVal, sal_uInt16 nWhichId)
bool	HasClickHdl () const
	Does the field possess an action on its ClickHandler? (e.g. INetFields, ...). More...
bool	IsFixed () const
bool	IsAutomaticLanguage () const
void	SetAutomaticLanguage (bool const bSet)
virtual OUString	GetDescription () const
bool	IsClickable () const
	Is this field clickable? More...
virtual void	dumpAsXml (xmlTextWriterPtr pWriter) const
const OUString &	GetTitle () const
void	SetTitle (const OUString &rTitle)

Private Attributes
OUString	m_aContent
sal_uInt16	m_nType

Additional Inherited Members
Protected Member Functions inherited from SwField
void	SetFormat (sal_uInt32 const nSet)
	SwField (SwFieldType *pTyp, sal_uInt32 nFormat=0, LanguageType nLang=LANGUAGE_SYSTEM, bool m_bUseFieldValueCache=true)

Detailed Description

Definition at line 565 of file docufld.hxx.

Constructor & Destructor Documentation

SwExtUserField()

SwExtUserField::SwExtUserField	(	SwExtUserFieldType *	pTyp,
		sal_uInt16	nSub,
		sal_uInt32	nFormat
	)

Definition at line 2060 of file docufld.cxx.

References SwExtUserFieldType::Expand(), m_aContent, and m_nType.

Referenced by Copy().

Member Function Documentation

Copy()

std::unique_ptr< SwField > SwExtUserField::Copy ( ) const

overridevirtual

Implements SwField.

Definition at line 2074 of file docufld.cxx.

References SwField::GetFormat(), SwField::GetTyp(), m_aContent, m_nType, and SwExtUserField().

ExpandImpl()

OUString SwExtUserField::ExpandImpl ( SwRootFrame const *  pLayout ) const

overridevirtual

Implements SwField.

Definition at line 2066 of file docufld.cxx.

References SwExtUserFieldType::Expand(), SwField::IsFixed(), m_aContent, and m_nType.

GetSubType()

sal_uInt16 SwExtUserField::GetSubType ( ) const

overridevirtual

Reimplemented from SwField.

Definition at line 2082 of file docufld.cxx.

References m_nType.

Referenced by sw::DocumentFieldsManager::SetFixFields(), and SwXTextField::update().

PutValue()

bool SwExtUserField::PutValue ( const css::uno::Any &  rVal, sal_uInt16  nWhich  )

overridevirtual

Reimplemented from SwField.

Definition at line 2115 of file docufld.cxx.

References AF_FIXED, FIELD_PROP_BOOL1, FIELD_PROP_PAR1, FIELD_PROP_USHORT1, SwField::GetFormat(), m_aContent, m_nType, and SwField::SetFormat().

QueryValue()

bool SwExtUserField::QueryValue ( css::uno::Any &  rVal, sal_uInt16  nWhich  ) const

overridevirtual

Reimplemented from SwField.

Definition at line 2092 of file docufld.cxx.

References FIELD_PROP_BOOL1, FIELD_PROP_PAR1, FIELD_PROP_USHORT1, SwField::IsFixed(), m_aContent, and m_nType.

SetExpansion()

void SwExtUserField::SetExpansion ( const OUString &  rStr )

inline

Definition at line 579 of file docufld.hxx.

References m_aContent.

Referenced by SwXTextField::attach(), sw::DocumentFieldsManager::SetFixFields(), and SwXTextField::update().

SetSubType()

void SwExtUserField::SetSubType ( sal_uInt16  nSub )

overridevirtual

Reimplemented from SwField.

Definition at line 2087 of file docufld.cxx.

References m_nType.

Member Data Documentation

m_aContent

OUString SwExtUserField::m_aContent

private

Definition at line 567 of file docufld.hxx.

Referenced by Copy(), ExpandImpl(), PutValue(), QueryValue(), SetExpansion(), and SwExtUserField().

m_nType

sal_uInt16 SwExtUserField::m_nType

private

Definition at line 568 of file docufld.hxx.

Referenced by Copy(), ExpandImpl(), GetSubType(), PutValue(), QueryValue(), SetSubType(), and SwExtUserField().

---

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

• docufld.hxx
• docufld.cxx