LibreOffice Module sw (master): SwValueField Class Reference

LibreOffice Module sw (master) 1

#include <fldbas.hxx>

Inheritance diagram for SwValueField:

Collaboration diagram for SwValueField:

Public Member Functions
virtual	~SwValueField () override

virtual SwFieldType *	ChgTyp (SwFieldType *) override
	Set a new type. More...

virtual void	SetLanguage (LanguageType nLng) override
	set language of the format More...

SwDoc *	GetDoc () const

virtual double	GetValue () const

virtual void	SetValue (const double &rVal)

OUString	ExpandValue (const double &rVal, sal_uInt32 nFormat, LanguageType nLng) const

void	dumpAsXml (xmlTextWriterPtr pWriter) const 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)

Static Public Member Functions
static sal_uInt32	GetSystemFormat (SvNumberFormatter *pFormatter, sal_uInt32 nFormat)
	get format in office language More...

Protected Member Functions
	SwValueField (SwValueFieldType *pFieldType, sal_uInt32 nFormat, LanguageType nLang=LANGUAGE_SYSTEM, const double fVal=0.0)

	SwValueField (const SwValueField &rField)

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)

Private Attributes
double	m_fValue

Detailed Description

Definition at line 450 of file fldbas.hxx.

Constructor & Destructor Documentation

◆ SwValueField() [1/2]

SwValueField::SwValueField	(	SwValueFieldType *	pFieldType,
		sal_uInt32	nFormat,
		LanguageType	nLang = `LANGUAGE_SYSTEM`,
		const double	fVal = `0.0`
	)

protected

Definition at line 676 of file fldbas.cxx.

◆ SwValueField() [2/2]

SwValueField::SwValueField ( const SwValueField & rField )

protected

Definition at line 683 of file fldbas.cxx.

References GetValue.

◆ ~SwValueField()

SwValueField::~SwValueField ( )

overridevirtual

Definition at line 689 of file fldbas.cxx.

Member Function Documentation

◆ ChgTyp()

SwFieldType * SwValueField::ChgTyp ( SwFieldType * pNewType )

overridevirtual

Set a new type.

This is needed/used for copying between documents. Needs to be always of the same type.

Parameters

pNewType The new type.

Returns: The old type.

Reimplemented from SwField.

Reimplemented in SwDBField.

Definition at line 700 of file fldbas.cxx.

References SwField::ChgTyp(), GetDoc(), SwField::GetFormat(), SvNumberFormatter::GetMergeFormatIndex(), SwDoc::GetNumberFormatter(), SwField::GetTyp(), SvNumberFormatter::HasMergeFormatTable(), and SwField::SetFormat().

Referenced by SwDBField::ChgTyp().

◆ dumpAsXml()

void SwValueField::dumpAsXml ( xmlTextWriterPtr pWriter ) const

overridevirtual

Reimplemented from SwField.

Reimplemented in SwUserField.

Definition at line 748 of file fldbas.cxx.

References SwField::dumpAsXml(), and m_fValue.

Referenced by SwUserField::dumpAsXml().

◆ ExpandValue()

OUString SwValueField::ExpandValue	(	const double &	rVal,
		sal_uInt32	nFormat,
		LanguageType	nLng
	)		const

inline

Definition at line 472 of file fldbas.hxx.

Referenced by SwGetExpField::ChangeExpansion(), SwDBField::ChgValue(), SwDBField::Evaluate(), SwDocInfoField::ExpandImpl(), SwDateTimeField::ExpandImpl(), SwGetExpField::SetValue(), SwSetExpField::SetValue(), and SwTableField::SetValue().

◆ GetDoc()

SwDoc * SwValueField::GetDoc ( ) const

inline

Definition at line 465 of file fldbas.hxx.

Referenced by ChgTyp(), SwDBField::Evaluate(), SwDocInfoField::ExpandImpl(), SwDateTimeField::ExpandImpl(), SwDateTimeField::GetDate(), SwFormulaField::GetExpandedFormula(), SwDateTimeField::GetValue(), SwDateTimeField::SetDateTime(), SwFormulaField::SetExpandedFormula(), SwFormulaField::SetFormula(), SetLanguage(), and SwDateTimeField::SwDateTimeField().

◆ GetSystemFormat()

sal_uInt32 SwValueField::GetSystemFormat	(	SvNumberFormatter *	pFormatter,
		sal_uInt32	nFormat
	)

static

get format in office language

Definition at line 718 of file fldbas.cxx.

References SvNumberFormatter::GetEntry(), SvNumberFormatter::GetFormatForLanguageIfBuiltIn(), SvNumberformat::GetFormatstring(), SvNumberformat::GetLanguage(), SvtSysLocale::GetLanguageTag(), LanguageTag::getLanguageType(), nType, and SvNumberFormatter::PutandConvertEntry().

Referenced by SwFieldVarPage::FillItemSet(), and IMPL_LINK().

◆ GetValue()

double SwValueField::GetValue ( ) const

virtual

Reimplemented in SwDateTimeField, and SwUserField.

Definition at line 799 of file fldbas.cxx.

References m_fValue.

Referenced by SwGetExpField::ChangeExpansion(), SwDBField::Copy(), SwGetExpField::Copy(), SwSetExpField::Copy(), SwTableField::Copy(), SwFormulaField::GetExpandedFormula(), SwFormulaField::GetInputOrDateTime(), SwDateTimeField::GetValue(), SwGetExpField::GetValue(), SwSetExpField::GetValue(), SwTableBox::GetValue(), SwDocInfoField::QueryValue(), SwGetExpField::QueryValue(), SwSetExpField::QueryValue(), SwSetExpField::SetValue(), and sw::DocumentFieldsManager::UpdateField().

◆ SetLanguage()

void SwValueField::SetLanguage ( LanguageType nLng )

overridevirtual

set language of the format

Reimplemented from SwField.

Reimplemented in SwDocInfoField, and SwGetExpField.

Definition at line 757 of file fldbas.cxx.

References GetDoc(), SvNumberFormatter::GetEntry(), SwField::GetFormat(), SvNumberFormatter::GetFormatForLanguageIfBuiltIn(), SvNumberformat::GetFormatstring(), SvNumberformat::GetLanguage(), SwDoc::GetNumberFormatter(), SwField::GetSubType(), SwField::GetTyp(), SwField::IsAutomaticLanguage(), LANGUAGE_SYSTEM, lcl_GetLanguageOfFormat(), nType, SvNumberFormatter::PutandConvertEntry(), SAL_MAX_UINT32, SwField::SetFormat(), SwField::SetLanguage(), nsSwExtendedSubType::SUB_CMD, SV_COUNTRY_LANGUAGE_OFFSET, User, and SwField::Which().

Referenced by SwDocInfoField::SetLanguage(), and SwGetExpField::SetLanguage().

◆ SetValue()

void SwValueField::SetValue ( const double & rVal )

virtual

Reimplemented in SwGetExpField, SwSetExpField, SwTableField, and SwUserField.

Definition at line 804 of file fldbas.cxx.

References m_fValue.

Referenced by SwXTextField::attach(), SwDBField::ChgValue(), SwDBField::FormatValue(), SwGetExpField::PutValue(), SwDateTimeField::SetDateTime(), SwFormulaField::SetExpandedFormula(), SwFormulaField::SetFormula(), SwGetExpField::SetValue(), SwSetExpField::SetValue(), SwTableField::SetValue(), and SwSetExpField::SwSetExpField().

Member Data Documentation

◆ m_fValue

double SwValueField::m_fValue

private

Definition at line 453 of file fldbas.hxx.

Referenced by dumpAsXml(), GetValue(), and SetValue().

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