SwGetExpField Class Reference

#include <expfld.hxx>

Inheritance diagram for SwGetExpField:

Collaboration diagram for SwGetExpField:

Public Member Functions
	SwGetExpField (SwGetExpFieldType *, const OUString &rFormel, sal_uInt16 nSubType, sal_uLong nFormat)
double	GetValue (SwRootFrame const *pLayout) const
void	SetValue (const double &rVal, SwRootFrame const *pLayout)
virtual void	SetLanguage (LanguageType nLng) override
	set language of the format More...
void	ChgExpStr (const OUString &rExpand, SwRootFrame const *pLayout)
bool	IsInBodyText () const
	Called by formatting. More...
void	ChgBodyTextFlag (bool bIsInBody)
	Set by UpdateExpFields where node position is known. More...
void	ChangeExpansion (const SwFrame &, const SwTextField &)
	For fields in header/footer/footnotes/flys: Only called by formatting!! More...
virtual OUString	GetFieldName () const override
	get name or content More...
virtual OUString	GetPar2 () const override
	Change formula. More...
virtual void	SetPar2 (const OUString &rStr) override
virtual sal_uInt16	GetSubType () const override
virtual void	SetSubType (sal_uInt16 nType) override
virtual bool	QueryValue (css::uno::Any &rVal, sal_uInt16 nWhich) const override
virtual bool	PutValue (const css::uno::Any &rVal, sal_uInt16 nWhich) override
void	SetLateInitialization ()
Public Member Functions inherited from SwFormulaField
virtual OUString	GetFormula () const override
void	SetFormula (const OUString &rStr)
void	SetExpandedFormula (const OUString &rStr)
OUString	GetExpandedFormula () const
OUString	GetInputOrDateTime () const
	Query formula or formatted value for dialog. More...
Public Member Functions inherited from SwValueField
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_Int32	GetReferenceTextPos (const SwFormatField &rFormat, SwDoc &rDoc, sal_Int32 nHint=0)
	Find the index of the reference text following the current field. More...
Static Public Member Functions inherited from SwValueField
static sal_uInt32	GetSystemFormat (SvNumberFormatter *pFormatter, sal_uInt32 nFormat)
	get format in office language More...

Private Member Functions
virtual OUString	ExpandImpl (SwRootFrame const *pLayout) const override
virtual std::unique_ptr< SwField >	Copy () const override
virtual void	SetValue (const double &rVal) override

Private Attributes
double	m_fValueRLHidden
	SwValueField; hidden redlines. More...
OUString	m_sExpand
OUString	m_sExpandRLHidden
	hidden redlines More...
bool	m_bIsInBodyText
sal_uInt16	m_nSubType
bool	m_bLateInitialization

Additional Inherited Members
Protected Member Functions inherited from SwFormulaField
	SwFormulaField (SwValueFieldType *pFieldType, sal_uInt32 nFormat, const double fVal)
	SwFormulaField (const SwFormulaField &rField)
Protected Member Functions inherited from SwValueField
	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)

Detailed Description

Definition at line 86 of file expfld.hxx.

Constructor & Destructor Documentation

SwGetExpField()

SwGetExpField::SwGetExpField	(	SwGetExpFieldType *	pTyp,
		const OUString &	rFormel,
		sal_uInt16	nSubType,
		sal_uLong	nFormat
	)

Definition at line 277 of file expfld.cxx.

References SwFormulaField::SetFormula().

Referenced by Copy().

Member Function Documentation

ChangeExpansion()

void SwGetExpField::ChangeExpansion	(	const SwFrame &	rFrame,
		const SwTextField &	rField
	)

For fields in header/footer/footnotes/flys: Only called by formatting!!

Definition at line 336 of file expfld.cxx.

References SwCalc::Calculate(), SwValueField::ExpandValue(), IDocumentFieldsAccess::FieldsToCalc(), IDocumentFieldsAccess::FieldsToExpand(), GetBodyTextNode(), SwPosition::GetContentIndex(), SwNode::GetDoc(), IDocumentFieldsAccess::GetFieldType(), SwField::GetFormat(), SwFormulaField::GetFormula(), SwDoc::getIDocumentFieldsAccess(), SwField::GetLanguage(), SwPosition::GetNode(), SwDoc::GetNodes(), SwFrame::GetPhyPageNum(), SwFrame::getRootFrame(), GetSubType(), SwTextField::GetTextNode(), SwField::GetTyp(), SwValueField::GetValue(), nsSwGetSetExpType::GSE_STRING, SwRootFrame::IsHideRedlines(), SwFrame::IsInDocBody(), LookString(), m_bIsInBodyText, m_bLateInitialization, m_sExpand, m_sExpandRLHidden, SetExp, SetSubType(), and SetValue().

Referenced by SwTextFormatter::NewFieldPortion().

ChgBodyTextFlag()

void SwGetExpField::ChgBodyTextFlag ( bool  bIsInBody )

inline

Set by UpdateExpFields where node position is known.

Definition at line 143 of file expfld.hxx.

References m_bIsInBodyText.

Referenced by SwDocUpdateField::GetBodyNode(), and SwTextFormatter::NewFieldPortion().

ChgExpStr()

void SwGetExpField::ChgExpStr	(	const OUString &	rExpand,
		SwRootFrame const *	pLayout
	)

Definition at line 289 of file expfld.cxx.

References SwRootFrame::IsHideRedlines(), m_sExpand, and m_sExpandRLHidden.

Referenced by SwXTextField::attach(), PutValue(), and sw::DocumentFieldsManager::UpdateExpFieldsImpl().

Copy()

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

overrideprivatevirtual

Implements SwField.

Definition at line 319 of file expfld.cxx.

References SwField::GetFormat(), SwFormulaField::GetFormula(), SwField::GetLanguage(), SwField::GetTyp(), SwValueField::GetValue(), SwField::IsAutomaticLanguage(), m_bIsInBodyText, m_bLateInitialization, m_fValueRLHidden, m_nSubType, m_sExpand, m_sExpandRLHidden, and SwGetExpField().

ExpandImpl()

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

overrideprivatevirtual

Implements SwField.

Definition at line 301 of file expfld.cxx.

References SwFormulaField::GetFormula(), SwRootFrame::IsHideRedlines(), m_nSubType, m_sExpand, m_sExpandRLHidden, and nsSwExtendedSubType::SUB_CMD.

GetFieldName()

OUString SwGetExpField::GetFieldName ( ) const

overridevirtual

get name or content

Returns

name or content.

Reimplemented from SwField.

Definition at line 309 of file expfld.cxx.

References Formel, Get, SwFormulaField::GetFormula(), SwFieldType::GetTypeStr(), nsSwGetSetExpType::GSE_FORMULA, m_nSubType, and nType.

GetPar2()

OUString SwGetExpField::GetPar2 ( ) const

overridevirtual

Change formula.

Reimplemented from SwField.

Definition at line 393 of file expfld.cxx.

References SwFormulaField::GetFormula().

GetReferenceTextPos()

sal_Int32 SwGetExpField::GetReferenceTextPos ( const SwFormatField &  rFormat, SwDoc &  rDoc, sal_Int32  nHint = 0  )

static

Find the index of the reference text following the current field.

Parameters

rFormat
rDoc
nHint	search starting position after the current field (or 0 if default)

Returns

Definition at line 965 of file expfld.cxx.

References g_pBreakIt, SfxItemSet::Get(), SwDoc::GetAttrPool(), SwTextNode::GetParaAttr(), SwBreakIt::GetRealScriptOfText(), SwTextAttr::GetStart(), SwTextNode::GetText(), SwFormatField::GetTextField(), SwTextField::GetTextNode(), GetWhichOfScript(), i, CharClass::isAlphaNumeric(), svl::Items, RES_CHRATR_CJK_FONT(), RES_CHRATR_CJK_LANGUAGE(), RES_CHRATR_CTL_FONT(), RES_CHRATR_CTL_LANGUAGE(), RES_CHRATR_FONT(), and RES_CHRATR_LANGUAGE().

Referenced by AttributeOutputBase::GenerateBookmarksForSequenceField(), SwGetRefField::UpdateField(), and SwTOXBaseSection::UpdateSequence().

GetSubType()

sal_uInt16 SwGetExpField::GetSubType ( ) const

overridevirtual

Reimplemented from SwField.

Definition at line 403 of file expfld.cxx.

References m_nSubType.

Referenced by ChangeExpansion(), PutValue(), and QueryValue().

GetValue()

double SwGetExpField::GetValue

(

SwRootFrame const *

pLayout

)

const

Definition at line 953 of file expfld.cxx.

References SwValueField::GetValue(), SwRootFrame::IsHideRedlines(), and m_fValueRLHidden.

IsInBodyText()

bool SwGetExpField::IsInBodyText ( ) const

inline

Called by formatting.

Definition at line 139 of file expfld.hxx.

References m_bIsInBodyText.

Referenced by SwTextField::ExpandTextField(), SwTextFormatter::NewFieldPortion(), and sw::DocumentFieldsManager::UpdateExpFieldsImpl().

PutValue()

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

overridevirtual

Reimplemented from SwField.

Definition at line 455 of file expfld.cxx.

References ChgExpStr(), FIELD_PROP_BOOL2, FIELD_PROP_DOUBLE, FIELD_PROP_FORMAT, FIELD_PROP_PAR1, FIELD_PROP_PAR4, FIELD_PROP_SUBTYPE, FIELD_PROP_USHORT1, GetSubType(), lcl_APIToSubType(), m_fValueRLHidden, m_nSubType, SwField::PutValue(), SwField::SetFormat(), SwFormulaField::SetFormula(), SetSubType(), SwValueField::SetValue(), and nsSwExtendedSubType::SUB_CMD.

QueryValue()

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

overridevirtual

Reimplemented from SwField.

Definition at line 421 of file expfld.cxx.

References FIELD_PROP_BOOL2, FIELD_PROP_DOUBLE, FIELD_PROP_FORMAT, FIELD_PROP_PAR1, FIELD_PROP_PAR4, FIELD_PROP_SUBTYPE, FIELD_PROP_USHORT1, SwField::GetFormat(), SwFormulaField::GetFormula(), GetSubType(), SwValueField::GetValue(), lcl_SubTypeToAPI(), m_nSubType, m_sExpand, SwField::QueryValue(), and nsSwExtendedSubType::SUB_CMD.

SetLanguage()

void SwGetExpField::SetLanguage ( LanguageType  nLng )

overridevirtual

set language of the format

Reimplemented from SwValueField.

Definition at line 413 of file expfld.cxx.

References m_nSubType, SwField::SetLanguage(), SwValueField::SetLanguage(), and nsSwExtendedSubType::SUB_CMD.

SetLateInitialization()

void SwGetExpField::SetLateInitialization ( )

inline

Definition at line 135 of file expfld.hxx.

Referenced by SwXTextField::attach().

SetPar2()

void SwGetExpField::SetPar2 ( const OUString &  rStr )

overridevirtual

Reimplemented from SwField.

Definition at line 398 of file expfld.cxx.

References SwFormulaField::SetFormula().

SetSubType()

void SwGetExpField::SetSubType ( sal_uInt16  nType )

overridevirtual

Reimplemented from SwField.

Definition at line 408 of file expfld.cxx.

References m_nSubType, and nType.

Referenced by ChangeExpansion(), and PutValue().

SetValue() [1/2]

void SwGetExpField::SetValue ( const double &  rVal )

overrideprivatevirtual

Reimplemented from SwValueField.

Definition at line 932 of file expfld.cxx.

References SwValueField::ExpandValue(), SwField::GetFormat(), SwField::GetLanguage(), SwField::GetTyp(), m_sExpand, and SwValueField::SetValue().

Referenced by ChangeExpansion(), SetValue(), and sw::DocumentFieldsManager::UpdateExpFieldsImpl().

SetValue() [2/2]

void SwGetExpField::SetValue	(	const double &	rVal,
		SwRootFrame const *	pLayout
	)

Definition at line 939 of file expfld.cxx.

References SwValueField::ExpandValue(), SwField::GetFormat(), SwField::GetLanguage(), SwField::GetTyp(), SwRootFrame::IsHideRedlines(), m_fValueRLHidden, m_sExpandRLHidden, and SetValue().

Member Data Documentation

m_bIsInBodyText

bool SwGetExpField::m_bIsInBodyText

private

Definition at line 91 of file expfld.hxx.

Referenced by ChangeExpansion(), ChgBodyTextFlag(), Copy(), and IsInBodyText().

m_bLateInitialization

bool SwGetExpField::m_bLateInitialization

private

Definition at line 94 of file expfld.hxx.

Referenced by ChangeExpansion(), and Copy().

m_fValueRLHidden

double SwGetExpField::m_fValueRLHidden

private

SwValueField; hidden redlines.

Definition at line 88 of file expfld.hxx.

Referenced by Copy(), GetValue(), PutValue(), and SetValue().

m_nSubType

sal_uInt16 SwGetExpField::m_nSubType

private

Definition at line 92 of file expfld.hxx.

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

m_sExpand

OUString SwGetExpField::m_sExpand

private

Definition at line 89 of file expfld.hxx.

Referenced by ChangeExpansion(), ChgExpStr(), Copy(), ExpandImpl(), QueryValue(), and SetValue().

m_sExpandRLHidden

OUString SwGetExpField::m_sExpandRLHidden

private

hidden redlines

Definition at line 90 of file expfld.hxx.

Referenced by ChangeExpansion(), ChgExpStr(), Copy(), ExpandImpl(), and SetValue().

---

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

• expfld.hxx
• expfld.cxx