SwField Class Reference

Base class of all fields. More...

#include <fldbas.hxx>

Inheritance diagram for SwField:

Collaboration diagram for SwField:

Public Member Functions
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)

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

Private Member Functions
virtual OUString	ExpandImpl (SwRootFrame const *pLayout) const =0
virtual std::unique_ptr< SwField >	Copy () const =0

Private Attributes
OUString	m_Cache
	Cached expansion (for clipboard). More...
SwFieldType *	m_pType
sal_uInt32	m_nFormat
LanguageType	m_nLang
	this can be either SvxNumType or SwChapterFormat depending on the subtype More...
bool	m_bUseFieldValueCache
bool	m_bIsAutomaticLanguage
	control the usage of the cached field value More...
OUString	m_aTitle
	Used for tooltip purposes when it's not-empty. More...

Detailed Description

Base class of all fields.

Type of field is queried via Which. Expanded content of field is queried via ExpandField().

Definition at line 294 of file fldbas.hxx.

Constructor & Destructor Documentation

SwField() [1/3]

SwField::SwField ( SwFieldType *  pTyp, sal_uInt32  nFormat = 0, LanguageType  nLang = LANGUAGE_SYSTEM, bool  m_bUseFieldValueCache = true  )

protected

Definition at line 233 of file fldbas.cxx.

References m_nFormat, and m_pType.

~SwField()

SwField::~SwField ( )

virtual

Definition at line 247 of file fldbas.cxx.

SwField() [2/3]

SwField::SwField ( SwField const &  )

default

SwField() [3/3]

SwField::SwField ( SwField &&  )

default

Member Function Documentation

ChangeFormat()

void SwField::ChangeFormat

(

sal_uInt32

n

)

Definition at line 445 of file fldbas.cxx.

References m_nFormat.

Referenced by SwDateTimeField::PutValue(), and SwDateTimeField::SwDateTimeField().

ChgTyp()

SwFieldType * SwField::ChgTyp ( SwFieldType *  pNewType )

virtual

Set new type (used for copying among documents).

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 in SwAuthorityField, SwDBField, and SwValueField.

Definition at line 406 of file fldbas.cxx.

References m_pType, and SwFieldType::Which().

Referenced by SwDoc::ChangeDBFields(), SwAuthorityField::ChgTyp(), SwValueField::ChgTyp(), SwTextField::CopyTextField(), and SwpHints::TryInsertHint().

Copy()

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

privatepure virtual

Implemented in SwAuthorityField, SwChapterField, SwDBField, SwDBNextSetField, SwDBNumSetField, SwDBNameField, SwDBSetNumberField, SwDDEField, SwPageNumberField, SwAuthorField, SwFileNameField, SwTemplNameField, SwDocStatField, SwHiddenTextField, SwHiddenParaField, SwMacroField, SwPostItField, SwDocInfoField, SwExtUserField, SwRefPageSetField, SwRefPageGetField, SwJumpEditField, SwScriptField, SwCombinedCharField, SwGetExpField, SwSetExpField, SwInputField, SwTableField, SwDateTimeField, SwDropDownField, SwGetRefField, and SwUserField.

Referenced by CopyField().

CopyField()

std::unique_ptr< SwField > SwField::CopyField

(

)

const

Definition at line 502 of file fldbas.cxx.

References Copy(), m_bUseFieldValueCache, and m_Cache.

Referenced by SwInsertDBColAutoPilot::DataToDoc(), SwFieldPage::InsertField(), SwFieldMgr::UpdateCurField(), and sw::DocumentFieldsManager::UpdateField().

dumpAsXml()

void SwField::dumpAsXml ( xmlTextWriterPtr  pWriter ) const

virtual

Reimplemented in SwAuthorityField, SwPostItField, SwValueField, and SwUserField.

Definition at line 882 of file fldbas.cxx.

References o3tl::strong_int< typename UNDERLYING_TYPE, typename PHANTOM_TYPE >::get(), m_aTitle, m_nFormat, and m_nLang.

Referenced by SwAuthorityField::dumpAsXml(), SwPostItField::dumpAsXml(), and SwValueField::dumpAsXml().

ExpandField()

OUString SwField::ExpandField	(	bool	bCached,
		SwRootFrame const *	pLayout
	)		const

expand the field.

Parameters

bCached

return cached field value.

Remarks

most callers should use the cached field value. this is because various fields need special handing (ChangeExpansion()) to return correct values, and only SwTextFormatter::NewFieldPortion() sets things up properly.

Parameters

pLayout

the layout to use for expansion; there are a few fields that expand differently via layout mode.

Returns

the generated text (suitable for display)

Definition at line 482 of file fldbas.cxx.

References Authority, SwAuthorityField::ConditionalExpandAuthIdentifier(), ExpandImpl(), GetTypeId(), m_bUseFieldValueCache, and m_Cache.

Referenced by SwDoc::ConvertFieldsToText(), RtfExport::DoFormText(), WW8Export::DoFormText(), SwEnhancedPDFExportHelper::EnhancedPDFExport(), SwTextField::ExpandTextField(), SwDoc::FieldHidesPara(), sw::DocumentFieldsManager::FieldsToExpand(), SwContentType::FillMemberList(), SwAuthorityField::GetAuthority(), SwTextInputField::GetFieldContent(), SwTextNode::GetMinMaxSize(), SwXTextField::getPresentation(), SwTextFrame::GetScalingOfSelectedText(), SwTableBox::GetValue(), lcl_ExportHints(), lcl_GetExpandedField(), lcl_GetText(), lcl_IsNoEndTextAttrAtPos(), SwTextFormatter::NewFieldPortion(), OutHTML_SwField(), SwWW8ImplReader::Read_F_DocInfo(), SwEditWin::RequestHelp(), SwFieldInputDlg::SwFieldInputDlg(), sw::DocumentFieldsManager::UpdateExpFieldsImpl(), and RtfAttributeOutput::WriteField_Impl().

ExpandImpl()

virtual OUString SwField::ExpandImpl ( SwRootFrame const *  pLayout ) const

privatepure virtual

Implemented in SwAuthorityField, SwChapterField, SwDBField, SwDBNextSetField, SwDBNumSetField, SwDBNameField, SwDBSetNumberField, SwDDEField, SwPageNumberField, SwAuthorField, SwFileNameField, SwTemplNameField, SwDocStatField, SwHiddenTextField, SwHiddenParaField, SwMacroField, SwPostItField, SwDocInfoField, SwExtUserField, SwRefPageSetField, SwRefPageGetField, SwJumpEditField, SwScriptField, SwCombinedCharField, SwGetExpField, SwSetExpField, SwInputField, SwTableField, SwDateTimeField, SwDropDownField, SwGetRefField, and SwUserField.

Referenced by ExpandField().

GetDescription()

OUString SwField::GetDescription ( ) const

virtual

Reimplemented in SwAuthorityField, SwPostItField, SwScriptField, and SwGetRefField.

Definition at line 860 of file fldbas.cxx.

References SwResId().

Referenced by SwContentType::FillMemberList(), and SwWrtShell::InsertField2().

GetFieldName()

OUString SwField::GetFieldName ( ) const

virtual

get name or content

Returns

name or content.

Reimplemented in SwDBField, SwDBNameInfField, SwHiddenTextField, SwMacroField, SwDocInfoField, SwGetExpField, SwSetExpField, SwInputField, SwTableField, SwGetRefField, and SwUserField.

Definition at line 309 of file fldbas.cxx.

References ShellResource::aFixedStr, Date, DATEFLD, DateTime, SwViewShell::GetShellRes(), GetSubType(), GetTyp(), GetTypeId(), SwFieldType::GetTypeStr(), IsFixed(), Time, and Which().

Referenced by SwContentType::FillMemberList(), SwDBNameInfField::GetFieldName(), SwInputField::GetFieldName(), SwXTextField::getPresentation(), SwTextFormatter::NewFieldPortion(), SwEditWin::RequestHelp(), and AttributeOutputBase::TextField().

GetFormat()

sal_uInt32 SwField::GetFormat ( ) const

inline

Query parameters for dialog and for BASIC.

Definition at line 406 of file fldbas.hxx.

References m_nFormat.

Referenced by SwGetExpField::ChangeExpansion(), SwRefPageGetField::ChangeExpansion(), SwDocStatField::ChangeExpansion(), SwValueField::ChgTyp(), SwDBField::ChgValue(), SwWrtShell::ClickToField(), SwChapterField::Copy(), SwDBField::Copy(), SwDBNameField::Copy(), SwDBSetNumberField::Copy(), SwPageNumberField::Copy(), SwAuthorField::Copy(), SwFileNameField::Copy(), SwTemplNameField::Copy(), SwDocStatField::Copy(), SwHiddenTextField::Copy(), SwDocInfoField::Copy(), SwExtUserField::Copy(), SwRefPageGetField::Copy(), SwJumpEditField::Copy(), SwGetExpField::Copy(), SwSetExpField::Copy(), SwInputField::Copy(), SwTableField::Copy(), SwDateTimeField::Copy(), SwGetRefField::Copy(), SwUserField::Copy(), SwDBField::Evaluate(), SwTextShell::ExecField(), SwTextShell::Execute(), SwChapterField::ExpandImpl(), SwDBSetNumberField::ExpandImpl(), SwPageNumberField::ExpandImpl(), SwAuthorField::ExpandImpl(), SwFileNameField::ExpandImpl(), SwTemplNameField::ExpandImpl(), SwDocStatField::ExpandImpl(), SwDocInfoField::ExpandImpl(), SwDateTimeField::ExpandImpl(), SwUserField::ExpandImpl(), SwFieldVarPage::FillFormatLB(), AttributeOutputBase::GenerateBookmarksForSequenceField(), SwFieldMgr::GetCurField(), SwFormulaField::GetExpandedFormula(), SwAccessibleParagraph::GetFieldTypeNameAtIndex(), MSWordExportBase::GetNumberFormat(), AttributeOutputBase::GetNumberPara(), SwUserField::GetPar2(), IsFixed(), SwJavaEditDialog::IsUpdate(), SwTextFormatter::NewFieldPortion(), OutHTML_SwField(), SwAuthorField::PutValue(), SwFileNameField::PutValue(), SwExtUserField::PutValue(), SwDateTimeField::QueryValue(), SwChapterField::QueryValue(), SwDBField::QueryValue(), SwDBSetNumberField::QueryValue(), SwPageNumberField::QueryValue(), SwAuthorField::QueryValue(), SwFileNameField::QueryValue(), SwTemplNameField::QueryValue(), SwDocStatField::QueryValue(), SwDocInfoField::QueryValue(), SwRefPageGetField::QueryValue(), SwJumpEditField::QueryValue(), SwGetExpField::QueryValue(), SwSetExpField::QueryValue(), SwTableField::QueryValue(), SwGetRefField::QueryValue(), SwUserField::QueryValue(), SwFieldDBPage::Reset(), SwFieldDokInfPage::Reset(), SwFieldDokPage::Reset(), SwFieldFuncPage::Reset(), SwFieldVarPage::Reset(), SwFormulaField::SetExpandedFormula(), sw::DocumentFieldsManager::SetFixFields(), SwFormulaField::SetFormula(), SwDocInfoField::SetLanguage(), SwValueField::SetLanguage(), SwUserField::SetPar2(), SwGetExpField::SetValue(), SwSetExpField::SetValue(), SwTableField::SetValue(), SwAuthorField::SwAuthorField(), SwFileNameField::SwFileNameField(), AttributeOutputBase::TextField(), SwFieldDBPage::TypeHdl(), SwXTextField::update(), SwGetRefField::UpdateField(), and SwRefPageGetFieldType::UpdateField().

GetFormula()

OUString SwField::GetFormula ( ) const

virtual

Reimplemented in SwFormulaField.

Definition at line 335 of file fldbas.cxx.

References GetPar2().

Referenced by SwDoc::ChangeDBFields(), and SwDoc::GetAllUsedDB().

GetLanguage()

LanguageType SwField::GetLanguage ( ) const

inline

Language at field position.

Definition at line 411 of file fldbas.hxx.

References m_nLang.

Referenced by SwGetExpField::ChangeExpansion(), SwDBField::ChgValue(), SwDBNameField::Copy(), SwDBSetNumberField::Copy(), SwPageNumberField::Copy(), SwGetExpField::Copy(), SwSetExpField::Copy(), SwDateTimeField::Copy(), SwEnhancedPDFExportHelper::EnhancedPDFExport(), SwDBField::Evaluate(), SwHiddenTextField::Evaluate(), SwPageNumberField::ExpandImpl(), SwDocInfoField::ExpandImpl(), SwDateTimeField::ExpandImpl(), SwUserField::ExpandImpl(), sw::annotation::SwAnnotationWin::GetLanguage(), MSWordExportBase::GetNumberFormat(), SwTextFormatter::NewFieldPortion(), sw::DocumentFieldsManager::SetFixFields(), SwGetExpField::SetValue(), SwSetExpField::SetValue(), SwTableField::SetValue(), SwDateTimeField::SwDateTimeField(), SwDocInfoField::SwDocInfoField(), SwFieldInputDlg::SwFieldInputDlg(), SwXTextField::update(), SwGetRefField::UpdateField(), and SwGetRefFieldType::UpdateGetReferences().

GetPar1()

OUString SwField::GetPar1 ( ) const

virtual

Reimplemented in SwDBField, SwDBNextSetField, SwDBNumSetField, SwDDEField, SwHiddenTextField, SwHiddenParaField, SwMacroField, SwPostItField, SwJumpEditField, SwScriptField, SwCombinedCharField, SwSetExpField, SwInputField, SwDropDownField, SwGetRefField, and SwUserField.

Definition at line 325 of file fldbas.cxx.

Referenced by SwDoc::ChangeDBFields(), SwFieldFuncPage::FillItemSet(), SwDoc::GetAllUsedDB(), SwFieldMgr::GetCurField(), SwDocUpdateField::MakeFieldList_(), OutHTML_SwFormatField(), RtfAttributeOutput::PlaceholderField(), SwWW8FltRefStack::RefToVar(), SwEditWin::RequestHelp(), AttributeOutputBase::TextField(), SwFieldDBPage::TypeHdl(), sw::DocumentFieldsManager::UpdateDBNumFields(), and DocxAttributeOutput::WritePendingPlaceholder().

GetPar2()

OUString SwField::GetPar2 ( ) const

virtual

Reimplemented in SwDBNumSetField, SwDDEField, SwPageNumberField, SwHiddenTextField, SwMacroField, SwPostItField, SwRefPageSetField, SwJumpEditField, SwScriptField, SwGetExpField, SwSetExpField, SwInputField, SwTableField, SwDateTimeField, SwDropDownField, SwGetRefField, and SwUserField.

Definition at line 330 of file fldbas.cxx.

Referenced by SwWrtShell::ClickToField(), SwFieldMgr::GetCurField(), GetFormula(), WW8AttributeOutput::HiddenField(), OutHTML_SwField(), OutHTML_SwFormatField(), WW8Export::OutputField(), SwEditWin::RequestHelp(), AttributeOutputBase::TextField(), SwFieldDBPage::TypeHdl(), and DocxAttributeOutput::WritePendingPlaceholder().

GetSubType()

sal_uInt16 SwField::GetSubType ( ) const

virtual

Reimplemented in SwDBField, SwDBNameInfField, SwPageNumberField, SwDocStatField, SwHiddenTextField, SwDocInfoField, SwExtUserField, SwGetExpField, SwSetExpField, SwInputField, SwTableField, SwDateTimeField, SwGetRefField, and SwUserField.

Definition at line 346 of file fldbas.cxx.

Referenced by sw::DocumentFieldsManager::FieldsToExpand(), SwContentType::FillMemberList(), AttributeOutputBase::GenerateBookmarksForSequenceField(), GetFieldName(), SwAccessibleParagraph::GetFieldTypeNameAtIndex(), GetTypeId(), IMPL_LINK(), IMPL_LINK_NOARG(), IsFixed(), SwWW8FltRefStack::IsFootnoteEdnBkmField(), lcl_GetServiceForField(), SwDocUpdateField::MakeFieldList_(), OutHTML_SwField(), OutHTML_SwFormatField(), WW8Export::OutputField(), SwEditWin::RequestHelp(), SwFieldDBPage::Reset(), SwFieldDokInfPage::Reset(), SwValueField::SetLanguage(), SwFormatField::SwClientNotify(), SwFieldEditDlg::SwFieldEditDlg(), AttributeOutputBase::TextField(), SwFieldDBPage::TypeHdl(), sw::DocumentFieldsManager::UpdateExpFieldsImpl(), and RtfAttributeOutput::WriteField_Impl().

GetTitle()

const OUString & SwField::GetTitle ( ) const

inline

Definition at line 397 of file fldbas.hxx.

Referenced by SwUserField::Copy(), and SwEditWin::RequestHelp().

GetTyp()

SwFieldType * SwField::GetTyp ( ) const

inline

Definition at line 401 of file fldbas.hxx.

References m_pType.

Referenced by SwInputField::applyFieldContent(), SwpHints::CalcFlags(), SwpHints::CalcHiddenParaField(), SwDoc::ChangeDBFields(), SwGetExpField::ChangeExpansion(), SwRefPageGetField::ChangeExpansion(), SwDocStatField::ChangeExpansion(), SwNodes::ChgNode(), SwAuthorityField::ChgTyp(), SwValueField::ChgTyp(), SwDBField::ChgValue(), SwWrtShell::ClickToField(), SwAuthorityField::ConditionalExpandAuthIdentifier(), SwDoc::ConvertFieldsToText(), SwGetRefField::ConvertProgrammaticToUIName(), SwAuthorityField::Copy(), SwChapterField::Copy(), SwDBField::Copy(), SwDBNextSetField::Copy(), SwDBNumSetField::Copy(), SwDBNameField::Copy(), SwDBSetNumberField::Copy(), SwDDEField::Copy(), SwPageNumberField::Copy(), SwAuthorField::Copy(), SwFileNameField::Copy(), SwTemplNameField::Copy(), SwDocStatField::Copy(), SwHiddenTextField::Copy(), SwHiddenParaField::Copy(), SwMacroField::Copy(), SwPostItField::Copy(), SwDocInfoField::Copy(), SwExtUserField::Copy(), SwRefPageSetField::Copy(), SwRefPageGetField::Copy(), SwJumpEditField::Copy(), SwScriptField::Copy(), SwCombinedCharField::Copy(), SwGetExpField::Copy(), SwSetExpField::Copy(), SwInputField::Copy(), SwTableField::Copy(), SwDateTimeField::Copy(), SwGetRefField::Copy(), SwUserField::Copy(), SwTextField::CopyTextField(), SwpHints::DeleteAtPos(), SwTextNode::DestroyAttr(), SwUndoFieldFromDoc::DoImpl(), sw::DropDownFieldDialog::DropDownFieldDialog(), SwDBField::Evaluate(), SwTextShell::ExecField(), SwTextShell::Execute(), SwAuthorityField::ExpandCitation(), SwDBNameField::ExpandImpl(), SwDDEField::ExpandImpl(), SwPageNumberField::ExpandImpl(), SwFileNameField::ExpandImpl(), SwTemplNameField::ExpandImpl(), SwDocStatField::ExpandImpl(), SwHiddenTextField::ExpandImpl(), SwDocInfoField::ExpandImpl(), SwSetExpField::ExpandImpl(), SwInputField::ExpandImpl(), SwUserField::ExpandImpl(), SwTextField::ExpandTextField(), SwDoc::FieldHidesPara(), sw::DocumentFieldsManager::FieldsToExpand(), SwTOXAuthority::FillText(), AttributeOutputBase::GenerateBookmarksForSequenceField(), SwAuthorityField::GetAbsoluteTargetURL(), SwAuthorityField::GetAbsoluteURL(), SwDoc::GetAllUsedDB(), SwAuthorityField::GetAuthority(), SwJumpEditField::GetCharFormat(), SwCursorShell::GetCurField(), SwFormulaField::GetExpandedFormula(), GetFieldName(), SwDBField::GetFieldName(), SwMacroField::GetFieldName(), SwSetExpField::GetFieldName(), SwInputField::GetFieldName(), SwTableField::GetFieldName(), SwGetRefField::GetFieldName(), SwUserField::GetFieldName(), SwXTextField::Impl::GetFieldType(), SwAccessibleParagraph::GetFieldTypeNameAtIndex(), SwTextShell::GetIdxState(), SwTableField::GetNodeOfFormula(), SwDBField::GetPar1(), SwDDEField::GetPar1(), SwSetExpField::GetPar1(), SwUserField::GetPar1(), SwDDEField::GetPar2(), SwSetExpField::GetPar2(), SwUserField::GetPar2(), sw::DocumentFieldsManager::GetRecordsPerDocument(), SwGetRefField::GetReferencedTextNode(), SwTextShell::GetState(), SwSetExpField::GetSubType(), SwUserField::GetSubType(), SwTOXAuthority::GetText(), SwAuthorityField::GetURI(), SwUserField::GetValue(), SwTableBox::GetValue(), SwFieldMgr::GoNextPrev(), SwPaM::HasReadonlySel(), IMPL_LINK(), SwHandleAnchorNodeChg::ImplDestroy(), SwDBField::InitContent(), SwAuthorMarkPane::InitControls(), SwDocUpdateField::InsDelFieldInFieldLst(), SwHTMLParser::InsertComment(), SwWrtShell::InsertField2(), SwTextNode::InsertHint(), SwWrtShell::InsertPostIt(), SwTextFrame::IsHiddenNow(), SwSetExpField::IsSequenceField(), lcl_CopyHint(), lcl_FindInputField(), SwXFieldMaster::LocalizeFormula(), SwDocUpdateField::MakeFieldList_(), SwTextFormatter::NewFieldPortion(), OutHTML_SwField(), OutHTML_SwFormatField(), WW8Export::OutputField(), SwDBField::PutValue(), SwSetExpField::PutValue(), SwAuthorityField::PutValue(), SwPostItField::QueryValue(), SwAuthorityField::QueryValue(), DocxAttributeOutput::RefField(), SwFormulaField::SetExpandedFormula(), sw::DocumentFieldsManager::SetFixFields(), SwValueField::SetLanguage(), SwAuthorityField::SetPar1(), SwDDEField::SetPar2(), SwSetExpField::SetPar2(), SwUserField::SetPar2(), SwUserField::SetSubType(), SwSetExpField::SetSubType(), SwGetExpField::SetValue(), SwSetExpField::SetValue(), SwTableField::SetValue(), SwUserField::SetValue(), SwTOXAuthority::sort_lt(), SwTextShell::StateField(), SwFieldVarPage::SubTypeHdl(), SwDBField::SwDBField(), SwDocInfoField::SwDocInfoField(), SwFieldInputDlg::SwFieldInputDlg(), SwFileNameField::SwFileNameField(), SwFormatField::SwFormatField(), SwJavaEditDialog::SwJavaEditDialog(), AttributeOutputBase::TextField(), SwpHints::TryInsertHint(), SwFieldDBPage::TypeHdl(), SwXTextField::update(), sw::DocumentFieldsManager::UpdateExpFieldsImpl(), SwGetRefField::UpdateField(), sw::DocumentFieldsManager::UpdateField(), SwWrtShell::UpdateInputFields(), SwEditShell::UpdateOneField(), RtfAttributeOutput::WriteExpand(), SwAuthorityField::~SwAuthorityField(), SwDBField::~SwDBField(), and SwDDEField::~SwDDEField().

GetTypeId()

SwFieldTypesEnum SwField::GetTypeId

(

)

const

Definition at line 261 of file fldbas.cxx.

References Date, DATEFLD, DateTime, FixedDate, FIXEDFLD, FixedTime, Formel, Get, GetExp, SwSetExpField::GetInputFlag(), GetSubType(), nsSwGetSetExpType::GSE_FORMULA, nsSwGetSetExpType::GSE_SEQ, HiddenText, m_pType, NextPage, PageNumber, PG_NEXT, PG_PREV, PreviousPage, Sequence, Set, SetExp, SetInput, Time, and SwFieldType::Which().

Referenced by SwTextShell::ExecField(), SwTextShell::Execute(), ExpandField(), SwContentType::FillMemberList(), SwFieldMgr::GetCurField(), SwFieldMgr::GetCurTypeId(), GetFieldName(), SwDocInfoField::GetFieldName(), SwAccessibleParagraph::GetFieldTypeNameAtIndex(), SwTextShell::GetState(), SwFieldMgr::GoNextPrev(), IMPL_LINK(), SwFieldEditDlg::Init(), SwTableBox::IsValidNumTextNd(), lcl_GetScrollToolTip(), SwEditWin::MouseButtonDown(), SwFEShell::RequestObjectResize(), SwFieldDBPage::Reset(), SwFieldDokPage::Reset(), SwFieldFuncPage::Reset(), SwFieldVarPage::Reset(), and SwFieldEditDlg::SwFieldEditDlg().

HasClickHdl()

bool SwField::HasClickHdl

(

)

const

Does the field possess an action on its ClickHandler? (e.g. INetFields, ...).

Does the field have an action on a ClickHandler? (E.g. INetFields,...)

Definition at line 416 of file fldbas.cxx.

References Dropdown, GetRef, Input, Internet, JumpEdit, m_pType, Macro, SetExp, TableOfAuthorities, and SwFieldType::Which().

Referenced by SwCursorShell::GetContentAtPos().

IsAutomaticLanguage()

bool SwField::IsAutomaticLanguage ( ) const

inline

Definition at line 386 of file fldbas.hxx.

Referenced by SwDocInfoField::Copy(), SwGetExpField::Copy(), SwSetExpField::Copy(), SwInputField::Copy(), SwTableField::Copy(), SwDateTimeField::Copy(), SwUserField::Copy(), SwFieldDokInfPage::Reset(), SwFieldDokPage::Reset(), SwFieldVarPage::Reset(), and SwValueField::SetLanguage().

IsClickable()

bool SwField::IsClickable

(

)

const

Is this field clickable?

Definition at line 865 of file fldbas.cxx.

References Dropdown, GetRef, Input, JumpEdit, Macro, SetExp, TableOfAuthorities, and Which().

Referenced by SwWrtShell::ClickToField(), and SwPageFrame::GetModelPositionForViewPoint().

IsFixed()

bool SwField::IsFixed

(

)

const

Definition at line 450 of file fldbas.cxx.

References AF_FIXED, Author, DateTime, nsSwDocInfoSubType::DI_SUB_FIXED, DocInfo, ExtUser, FF_FIXED, Filename, FixDate, FIXEDFLD, FixTime, GetFormat(), GetSubType(), m_pType, and SwFieldType::Which().

Referenced by SwHTMLParser::EndField(), SwAuthorField::ExpandImpl(), SwFileNameField::ExpandImpl(), SwDocInfoField::ExpandImpl(), SwExtUserField::ExpandImpl(), SwDateTimeField::ExpandImpl(), GetFieldName(), SwDocInfoField::GetFieldName(), SwDateTimeField::GetValue(), OutHTML_SwField(), SwFileNameField::PutValue(), SwDateTimeField::QueryValue(), SwAuthorField::QueryValue(), SwFileNameField::QueryValue(), SwExtUserField::QueryValue(), sw::DocumentFieldsManager::SetFixFields(), and SwDateTimeField::SwDateTimeField().

operator=() [1/2]

SwField & SwField::operator= ( SwField &&  )

default

operator=() [2/2]

SwField & SwField::operator= ( SwField const &  )

default

PutValue()

bool SwField::PutValue ( const css::uno::Any &  rVal, sal_uInt16  nWhichId  )

virtual

Reimplemented in SwDateTimeField, SwChapterField, SwDBField, SwDBNameInfField, SwDBNextSetField, SwDBNumSetField, SwDBNameField, SwDBSetNumberField, SwPageNumberField, SwAuthorField, SwFileNameField, SwTemplNameField, SwDocStatField, SwHiddenTextField, SwHiddenParaField, SwMacroField, SwPostItField, SwDocInfoField, SwExtUserField, SwRefPageSetField, SwRefPageGetField, SwJumpEditField, SwScriptField, SwCombinedCharField, SwGetExpField, SwSetExpField, SwInputField, SwTableField, SwAuthorityField, SwDropDownField, SwGetRefField, and SwUserField.

Definition at line 373 of file fldbas.cxx.

References FIELD_PROP_BOOL4, FIELD_PROP_TITLE, m_aTitle, and m_bIsAutomaticLanguage.

Referenced by SwUndoFieldFromAPI::DoImpl(), SwDateTimeField::PutValue(), SwDocInfoField::PutValue(), SwGetExpField::PutValue(), SwSetExpField::PutValue(), SwUserField::PutValue(), sw::DocumentFieldsManager::PutValueToField(), and SwUndoFieldFromAPI::UndoImpl().

QueryValue()

bool SwField::QueryValue ( css::uno::Any &  rVal, sal_uInt16  nWhichId  ) const

virtual

Reimplemented in SwDateTimeField, SwChapterField, SwDBField, SwDBNameInfField, SwDBNextSetField, SwDBNumSetField, SwDBNameField, SwDBSetNumberField, SwPageNumberField, SwAuthorField, SwFileNameField, SwTemplNameField, SwDocStatField, SwHiddenTextField, SwHiddenParaField, SwMacroField, SwPostItField, SwDocInfoField, SwExtUserField, SwRefPageSetField, SwRefPageGetField, SwJumpEditField, SwScriptField, SwCombinedCharField, SwGetExpField, SwSetExpField, SwInputField, SwTableField, SwAuthorityField, SwDropDownField, SwGetRefField, and SwUserField.

Definition at line 355 of file fldbas.cxx.

References FIELD_PROP_BOOL4, FIELD_PROP_TITLE, m_aTitle, and m_bIsAutomaticLanguage.

Referenced by SwXTextField::getPropertyValue(), sw::DocumentFieldsManager::PutValueToField(), SwDateTimeField::QueryValue(), SwDocInfoField::QueryValue(), SwGetExpField::QueryValue(), SwSetExpField::QueryValue(), and SwUserField::QueryValue().

SetAutomaticLanguage()

void SwField::SetAutomaticLanguage ( bool const  bSet )

inline

Definition at line 389 of file fldbas.hxx.

Referenced by SwWW8ImplReader::ForceFieldLanguage().

SetFormat()

void SwField::SetFormat ( sal_uInt32 const  nSet )

inlineprotected

Definition at line 310 of file fldbas.hxx.

References m_nFormat.

Referenced by SwValueField::ChgTyp(), SwDBField::Evaluate(), SwChapterField::PutValue(), SwDBField::PutValue(), SwDBSetNumberField::PutValue(), SwPageNumberField::PutValue(), SwAuthorField::PutValue(), SwFileNameField::PutValue(), SwTemplNameField::PutValue(), SwDocStatField::PutValue(), SwDocInfoField::PutValue(), SwExtUserField::PutValue(), SwRefPageGetField::PutValue(), SwJumpEditField::PutValue(), SwGetExpField::PutValue(), SwSetExpField::PutValue(), SwTableField::PutValue(), SwGetRefField::PutValue(), SwUserField::PutValue(), and SwValueField::SetLanguage().

SetLanguage()

void SwField::SetLanguage ( LanguageType  nLng )

virtual

Reimplemented in SwDocInfoField, SwGetExpField, and SwValueField.

Definition at line 440 of file fldbas.cxx.

References m_nLang, and nLang.

Referenced by SwWW8ImplReader::ForceFieldLanguage(), SwTextFormatter::NewFieldPortion(), SwDocInfoField::SetLanguage(), SwGetExpField::SetLanguage(), SwValueField::SetLanguage(), and SwGetRefFieldType::UpdateGetReferences().

SetPar1()

void SwField::SetPar1 ( const OUString &  rStr )

virtual

Reimplemented in SwAuthorityField, SwDBNextSetField, SwDBNumSetField, SwHiddenTextField, SwHiddenParaField, SwMacroField, SwPostItField, SwJumpEditField, SwScriptField, SwCombinedCharField, SwInputField, SwDropDownField, and SwGetRefField.

Definition at line 340 of file fldbas.cxx.

Referenced by SwDoc::ChangeDBFields(), and SwSetExpField::PutValue().

SetPar2()

void SwField::SetPar2 ( const OUString &  rStr )

virtual

Reimplemented in SwDBNumSetField, SwDDEField, SwPageNumberField, SwHiddenTextField, SwMacroField, SwPostItField, SwRefPageSetField, SwJumpEditField, SwScriptField, SwGetExpField, SwSetExpField, SwInputField, SwTableField, SwDateTimeField, SwDropDownField, and SwUserField.

Definition at line 343 of file fldbas.cxx.

Referenced by SwDoc::ChangeDBFields().

SetSubType()

void SwField::SetSubType ( sal_uInt16  )

virtual

Reimplemented in SwGetRefField, SwDocStatField, SwExtUserField, SwInputField, SwDateTimeField, SwUserField, SwDBField, SwDBNameInfField, SwGetExpField, SwSetExpField, SwTableField, and SwDocInfoField.

Definition at line 351 of file fldbas.cxx.

Referenced by SwInsertDBColAutoPilot::SplitTextToColArr().

SetTitle()

void SwField::SetTitle ( const OUString &  rTitle )

inline

Definition at line 398 of file fldbas.hxx.

Which()

SwFieldIds SwField::Which

(

)

const

ResId.

Definition at line 254 of file fldbas.cxx.

References m_pType, and SwFieldType::Which().

Referenced by SwTaggedPDFHelper::BeginInlineStructureElements(), sw::annotation::SwAnnotationWin::CalcParent(), sw::annotation::SwAnnotationWin::CountFollowing(), SwXTextField::getAnchor(), SwCursorShell::GetContentAtPos(), GetFieldName(), SwCursorShell::GetPostItFieldAtCursor(), IsClickable(), SwWW8FltRefStack::IsFootnoteEdnBkmField(), lcl_FindInputField(), lcl_GetServiceForField(), SwEditWin::MouseMove(), OutHTML_SwTextNode(), SwWW8FltRefStack::RefToVar(), SwEditWin::RequestHelp(), SwValueField::SetLanguage(), SwXTextField::setPropertyValue(), SwXTextField::update(), and sw::DocumentFieldsManager::UpdateDBNumFields().

Member Data Documentation

m_aTitle

OUString SwField::m_aTitle

private

Used for tooltip purposes when it's not-empty.

Definition at line 304 of file fldbas.hxx.

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

m_bIsAutomaticLanguage

bool SwField::m_bIsAutomaticLanguage

private

control the usage of the cached field value

Definition at line 302 of file fldbas.hxx.

Referenced by PutValue(), and QueryValue().

m_bUseFieldValueCache

bool SwField::m_bUseFieldValueCache

private

Definition at line 301 of file fldbas.hxx.

Referenced by CopyField(), and ExpandField().

m_Cache

OUString SwField::m_Cache

mutableprivate

Cached expansion (for clipboard).

Definition at line 297 of file fldbas.hxx.

Referenced by CopyField(), and ExpandField().

m_nFormat

sal_uInt32 SwField::m_nFormat

private

Definition at line 299 of file fldbas.hxx.

Referenced by ChangeFormat(), dumpAsXml(), and GetFormat().

m_nLang

LanguageType SwField::m_nLang

private

this can be either SvxNumType or SwChapterFormat depending on the subtype

Always change via SetLanguage!

Definition at line 300 of file fldbas.hxx.

Referenced by dumpAsXml(), GetLanguage(), and SetLanguage().

m_pType

SwFieldType* SwField::m_pType

private

Definition at line 298 of file fldbas.hxx.

Referenced by ChgTyp(), GetTyp(), GetTypeId(), HasClickHdl(), IsFixed(), SwField(), and Which().

---

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

• fldbas.hxx
• fldbas.cxx