LibreOffice Module sw (master) 1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
SwFieldType Class Referenceabstract

Instances of SwFields and those derived from it occur 0 to n times. More...

#include <fldbas.hxx>

Inheritance diagram for SwFieldType:
[legend]
Collaboration diagram for SwFieldType:
[legend]

Public Member Functions

unotools::WeakReference< SwXFieldMaster > const & GetXObject () const
 
void SetXObject (rtl::Reference< SwXFieldMaster > 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
 
void UpdateDocPos (const SwTwips nDocPos)
 
virtual void UpdateFields ()
 

Static Public Member Functions

static const OUString & GetTypeStr (SwFieldTypesEnum nTypeId)
 

Protected Member Functions

 SwFieldType (SwFieldIds nWhichId)
 Single argument ctors shall be explicit. More...
 

Static Private Member Functions

static void GetFieldName_ ()
 Sets up FieldNames; fldmgr.cxx! More...
 

Private Attributes

unotools::WeakReference< SwXFieldMaster > m_wXFieldMaster
 
SwFieldIds m_nWhich
 

Static Private Attributes

static std::vector< OUString > * s_pFieldNames = nullptr
 field names More...
 

Friends

void FinitUI ()
 In order to delete pointer! More...
 

Detailed Description

Instances of SwFields and those derived from it occur 0 to n times.

For each class there is one instance of the associated type class. Base class of all field types is SwFieldType.

Definition at line 246 of file fldbas.hxx.

Constructor & Destructor Documentation

◆ SwFieldType()

SwFieldType::SwFieldType ( SwFieldIds  nWhichId)
explicitprotected

Single argument ctors shall be explicit.

Definition at line 133 of file fldbas.cxx.

Member Function Documentation

◆ CollectPostIts()

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

Definition at line 183 of file fldbas.cxx.

Referenced by SwPostItMgr::AddPostIts().

◆ Copy()

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

Implemented in SwAuthorityFieldType, SwChapterFieldType, SwDBFieldType, SwDBNextSetFieldType, SwDBNumSetFieldType, SwDBNameFieldType, SwDBSetNumberFieldType, SwDDEFieldType, SwPageNumberFieldType, SwAuthorFieldType, SwFileNameFieldType, SwTemplNameFieldType, SwDocStatFieldType, SwHiddenTextFieldType, SwHiddenParaFieldType, SwMacroFieldType, SwPostItFieldType, SwDocInfoFieldType, SwExtUserFieldType, SwRefPageSetFieldType, SwRefPageGetFieldType, SwJumpEditFieldType, SwScriptFieldType, SwCombinedCharFieldType, SwGetExpFieldType, SwSetExpFieldType, SwInputFieldType, SwTableFieldType, SwDateTimeFieldType, SwDropDownFieldType, SwGetRefFieldType, and SwUserFieldType.

Referenced by sw::DocumentFieldsManager::InsertFieldType().

◆ dumpAsXml()

void SwFieldType::dumpAsXml ( xmlTextWriterPtr  pWriter) const
virtual

Reimplemented in SwAuthorityFieldType, and SwUserFieldType.

Definition at line 157 of file fldbas.cxx.

References GatherFields().

Referenced by SwAuthorityFieldType::dumpAsXml(), and SwUserFieldType::dumpAsXml().

◆ FindFormatForField()

SwFormatField * SwFieldType::FindFormatForField ( const SwField *  pField) const

Definition at line 171 of file fldbas.cxx.

Referenced by SwTableField::GetNodeOfFormula(), and SwWrtShell::InsertPostIt().

◆ FindFormatForPostItId()

SwFormatField * SwFieldType::FindFormatForPostItId ( sal_uInt32  nPostItId) const

Definition at line 177 of file fldbas.cxx.

Referenced by SwTextShell::ExecField().

◆ GatherDdeTables()

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

Definition at line 210 of file fldbas.cxx.

Referenced by SwDDEFieldType::UpdateDDE().

◆ GatherFields()

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

Definition at line 205 of file fldbas.cxx.

Referenced by SwInputFieldList::BuildSortLst(), SwTable::CanConvertSubtables(), SwDoc::ConvertFieldsToText(), SwXFieldMaster::dispose(), dumpAsXml(), SwEnhancedPDFExportHelper::EnhancedPDFExport(), SwTextShell::ExecIdx(), SwEnhancedPDFExportHelper::ExportAuthorityEntryLinks(), SwContentType::FillMemberList(), SwGetRefFieldType::FindAnchor(), sw::mark::AnnotationMark::GetAnnotationFormatField(), SwXFieldMaster::getPropertyValue(), SwSetExpFieldType::GetSeqFieldList(), SwSetExpFieldType::GetSeqFormat(), SwAuthorityFieldType::GetSequencePos(), SwDoc::HasInvisibleContent(), sw::DocumentStatisticsManager::IncrementalDocStatCalculate(), lcl_MakeFieldLst(), SwRefPageGetFieldType::MakeSetList(), SwGetRefFieldType::MergeWithOtherDoc(), SwDBFieldType::PutValue(), SwDoc::RemoveInvisibleContent(), sw::DocumentFieldsManager::SetFixFields(), SwSetExpFieldType::SetSeqFormat(), SwSetExpFieldType::SetSeqRefNo(), sw_GetPostIts(), SwRefPageGetFieldType::SwClientNotify(), SwInputFieldList::SwInputFieldList(), SwXFieldEnumeration::SwXFieldEnumeration(), SwTOXBaseSection::UpdateAuthorities(), SwDDEFieldType::UpdateDDE(), SwTable::UpdateFields(), SwGetRefFieldType::UpdateGetReferences(), and SwTOXBaseSection::UpdateSequence().

◆ GatherNodeIndex()

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

Definition at line 195 of file fldbas.cxx.

Referenced by MSWordExportBase::GatherChapterFields().

◆ GatherRefFields()

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

Definition at line 200 of file fldbas.cxx.

Referenced by MSWordExportBase::HasRefToAttr(), and MSWordExportBase::HasRefToFootOrEndnote().

◆ GetFieldName_()

void SwFieldType::GetFieldName_ ( )
staticprivate

Sets up FieldNames; fldmgr.cxx!

Definition at line 1788 of file fldmgr.cxx.

References MnemonicGenerator::EraseAllMnemonicChars(), s_pFieldNames, SAL_N_ELEMENTS, and SwResId().

Referenced by GetTypeStr().

◆ GetName()

OUString SwFieldType::GetName ( ) const
virtual

Only in derived classes.

Reimplemented in SwDBFieldType, SwDDEFieldType, SwSetExpFieldType, and SwUserFieldType.

Definition at line 139 of file fldbas.cxx.

Referenced by SwXTextField::attachTextFieldMaster(), SwSetExpField::ExpandImpl(), sw::DocumentFieldsManager::FieldsToExpand(), SwMacroField::GetFieldName(), SwInputField::GetFieldName(), SwTableField::GetFieldName(), SwGetRefField::GetFieldName(), SwUserField::GetFieldName(), sw::DocumentFieldsManager::GetFieldType(), SwAccessibleParagraph::GetFieldTypeNameAtIndex(), SwXTextFieldMasters::getInstanceName(), SwXFieldMaster::GetProgrammaticName(), SwFieldMgr::GetSubTypes(), sw::DocumentFieldsManager::InsDeletedFieldType(), SwView::InsertCaption(), sw::DocumentFieldsManager::InsertFieldType(), lcl_InsertDrawLabel(), lcl_InsertLabel(), SwXFieldMaster::LocalizeFormula(), SwGetRefFieldType::MergeWithOtherDoc(), OutHTML_SwFormatField(), SwTransferable::PasteDDE(), SwEditShell::RemoveFieldType(), SwTOXSelectTabPage::Reset(), SwXFieldMaster::setPropertyValue(), SwCaptionDialog::SwCaptionDialog(), SwCaptionOptPage::SwCaptionOptPage(), AttributeOutputBase::TextField(), SwCaptionOptPage::UpdateEntry(), sw::DocumentFieldsManager::UpdateExpFieldsImpl(), and RtfAttributeOutput::WriteExpand().

◆ GetTypeStr()

const OUString & SwFieldType::GetTypeStr ( SwFieldTypesEnum  nTypeId)
static

Definition at line 124 of file fldbas.cxx.

References GetFieldName_(), and s_pFieldNames.

Referenced by SwFieldDokPage::AddSubType(), SwDBManager::FillCalcWithMergeData(), SwField::GetFieldName(), SwHiddenTextField::GetFieldName(), SwDocInfoField::GetFieldName(), SwGetExpField::GetFieldName(), SwSetExpField::GetFieldName(), SwUserField::GetFieldName(), SwAccessibleParagraph::GetFieldTypeNameAtIndex(), SwFieldMgr::GetTypeStr(), lcl_GetScrollToolTip(), sw::DocumentFieldsManager::UpdateExpFieldsImpl(), SwCalc::VarLook(), and SwTextFormatter::WhichTextPor().

◆ GetXObject()

unotools::WeakReference< SwXFieldMaster > const & SwFieldType::GetXObject ( ) const
inline

Definition at line 263 of file fldbas.hxx.

Referenced by SwXFieldMaster::CreateXFieldMaster().

◆ HasHiddenInformationNotes()

bool SwFieldType::HasHiddenInformationNotes ( ) const

Definition at line 188 of file fldbas.cxx.

◆ PrintHiddenPara()

void SwFieldType::PrintHiddenPara ( )

Definition at line 151 of file fldbas.cxx.

References RES_HIDDENPARA_PRINT().

Referenced by SwViewShell::ImplApplyViewOptions().

◆ PutValue()

void SwFieldType::PutValue ( const css::uno::Any &  rVal,
sal_uInt16  nWhich 
)
virtual

Reimplemented in SwUserFieldType, SwDBFieldType, SwDDEFieldType, SwSetExpFieldType, and SwAuthorityFieldType.

Definition at line 147 of file fldbas.cxx.

Referenced by SwXFieldMaster::setPropertyValue().

◆ QueryValue()

void SwFieldType::QueryValue ( css::uno::Any &  rVal,
sal_uInt16  nWhich 
) const
virtual

Reimplemented in SwUserFieldType, SwDBFieldType, SwDDEFieldType, SwSetExpFieldType, and SwAuthorityFieldType.

Definition at line 144 of file fldbas.cxx.

Referenced by SwXFieldMaster::getPropertyValue().

◆ SetXObject()

void SwFieldType::SetXObject ( rtl::Reference< SwXFieldMaster > const &  xFieldMaster)

Definition at line 224 of file fldbas.cxx.

References m_wXFieldMaster.

Referenced by SwXFieldMaster::CreateXFieldMaster().

◆ UpdateDocPos()

void SwFieldType::UpdateDocPos ( const SwTwips  nDocPos)

Definition at line 215 of file fldbas.cxx.

Referenced by sw::DocumentFieldsManager::UpdatePageFields().

◆ UpdateFields()

void SwFieldType::UpdateFields ( )
virtual

Reimplemented in SwDBFieldType, SwDDEFieldType, SwHiddenTextFieldType, SwHiddenParaFieldType, SwRefPageSetFieldType, SwJumpEditFieldType, SwGetExpFieldType, SwSetExpFieldType, SwTableFieldType, and SwGetRefFieldType.

Definition at line 219 of file fldbas.cxx.

Referenced by SwFieldInputDlg::Apply(), SwInputField::applyFieldContent(), SwDoc::ChgDBData(), SwDoc::ChgPageDesc(), SwWrtShell::ClickToField(), sw::DocumentStatisticsManager::DocInfoChgd(), IMPL_LINK(), sw::DocumentStatisticsManager::IncrementalDocStatCalculate(), SwFieldMgr::InsertField(), SwXFieldMaster::setPropertyValue(), SwUserFieldType::SwClientNotify(), UnHide(), SwFieldMgr::UpdateCurField(), sw::DocumentFieldsManager::UpdateField(), sw::UpdateFieldsForRedline(), SwWrtShell::UpdateInputFields(), SwTOXMgr::UpdateOrInsertTOX(), and SwNodes::UpdateOutlineNode().

◆ Which()

SwFieldIds SwFieldType::Which ( ) const
inline

Definition at line 276 of file fldbas.hxx.

Referenced by SwXTextField::attachTextFieldMaster(), SwInputFieldList::BuildSortLst(), SwpHints::CalcFlags(), SwpHints::CalcHiddenParaField(), SwDoc::ChangeAuthorityData(), SwDoc::ChangeDBFields(), SwNodes::ChgNode(), SwField::ChgTyp(), SwWrtShell::ClickToField(), SwDoc::ConvertFieldsToText(), SwTextField::CopyTextField(), SwpHints::DeleteAtPos(), SwTextNode::DestroyAttr(), sw::DropDownFieldDialog::DropDownFieldDialog(), SwTextShell::ExecField(), SwTextShell::Execute(), SwTextField::ExpandTextField(), SwDoc::FieldHidesPara(), sw::DocumentFieldsManager::FieldsToExpand(), SwContentType::FillMemberList(), AttributeOutputBase::GenerateBookmarksForSequenceField(), SwDoc::GetAllUsedDB(), SwCursorShell::GetCurField(), sw::DocumentFieldsManager::GetFieldType(), GetFieldTypeMId(), SwAccessibleParagraph::GetFieldTypeNameAtIndex(), SwTextShell::GetIdxState(), SwXTextFieldMasters::getInstanceName(), SwXFieldMaster::GetProgrammaticName(), sw::DocumentFieldsManager::GetRecordsPerDocument(), SwTextShell::GetState(), SwFieldMgr::GetSubTypes(), SwField::GetTypeId(), SwTableBox::GetValue(), SwFieldMgr::GoNextPrev(), SwField::HasClickHdl(), SwPaM::HasReadonlySel(), IMPL_LINK(), SwHandleAnchorNodeChg::ImplDestroy(), SwAuthorMarkPane::InitControls(), sw::DocumentFieldsManager::InsDeletedFieldType(), SwDocUpdateField::InsDelFieldInFieldLst(), SwView::InsertCaption(), SwHTMLParser::InsertComment(), SwWrtShell::InsertField2(), sw::DocumentFieldsManager::InsertFieldType(), SwDocUpdateField::InsertFieldType(), SwTextNode::InsertHint(), SwWrtShell::InsertPostIt(), SwField::IsFixed(), SwTextFrame::IsHiddenNow(), lcl_CopyHint(), lcl_InsertDrawLabel(), lcl_InsertLabel(), SwDocUpdateField::MakeFieldList_(), SwCursorShell::MoveFieldType(), SwTextFormatter::NewFieldPortion(), OutHTML_SwField(), OutHTML_SwFormatField(), WW8Export::OutputField(), SwTransferable::PasteDDE(), DocxAttributeOutput::RefField(), SwDocUpdateField::RemoveFieldType(), sw::DocumentFieldsManager::RemoveFieldType(), SwEditShell::RemoveFieldType(), SwTOXSelectTabPage::Reset(), SwXFieldMaster::setPropertyValue(), SwTextShell::StateField(), SwCaptionDialog::SwCaptionDialog(), SwFieldInputDlg::SwFieldInputDlg(), SwInputFieldList::SwInputFieldList(), SwJavaEditDialog::SwJavaEditDialog(), AttributeOutputBase::TextField(), SwpHints::TryInsertHint(), SwCaptionOptPage::UpdateEntry(), sw::DocumentFieldsManager::UpdateExpFieldsImpl(), sw::DocumentFieldsManager::UpdateField(), SwWrtShell::UpdateInputFields(), SwEditShell::UpdateOneField(), sw::DocumentFieldsManager::UpdatePageFields(), sw::DocumentFieldsManager::UpdateUsrFields(), SwCalc::VarLook(), SwField::Which(), RtfAttributeOutput::WriteExpand(), and SwFormatField::~SwFormatField().

Friends And Related Function Documentation

◆ FinitUI

void FinitUI ( )
friend

In order to delete pointer!

Definition at line 68 of file initui.cxx.

Member Data Documentation

◆ m_nWhich

SwFieldIds SwFieldType::m_nWhich
private

Definition at line 250 of file fldbas.hxx.

◆ m_wXFieldMaster

unotools::WeakReference<SwXFieldMaster> SwFieldType::m_wXFieldMaster
private

Definition at line 248 of file fldbas.hxx.

Referenced by SetXObject().

◆ s_pFieldNames

std::vector< OUString > * SwFieldType::s_pFieldNames = nullptr
staticprivate

field names

Definition at line 253 of file fldbas.hxx.

Referenced by GetFieldName_(), and GetTypeStr().

The documentation for this class was generated from the following files:
Generated on Sat May 27 2023 07:00:37 for LibreOffice Module sw (master) by doxygen 1.9.3