LibreOffice Module sw (master) 1
Public Member Functions | Protected Member Functions | List of all members
IDocumentFieldsAccess Class Referenceabstract

Document fields related interfaces. More...

#include <IDocumentFieldsAccess.hxx>

Inheritance diagram for IDocumentFieldsAccess:
[legend]

Public Member Functions

virtual const SwFieldTypes * GetFieldTypes () const =0
 
virtual SwFieldType * InsertFieldType (const SwFieldType &)=0
 
virtual SwFieldType * GetSysFieldType (const SwFieldIds eWhich) const =0
 
virtual SwFieldType * GetFieldType (SwFieldIds nResId, const OUString &rName, bool bDbFieldMatching) const =0
 
virtual void RemoveFieldType (size_t nField)=0
 
virtual void UpdateFields (bool bCloseDB)=0
 
virtual void InsDeletedFieldType (SwFieldType &)=0
 
virtual void PutValueToField (const SwPosition &rPos, const css::uno::Any &rVal, sal_uInt16 nWhich)=0
 Puts a value into a field at a certain position. More...
 
virtual bool UpdateField (SwTextField *rDstFormatField, SwField &rSrcField, bool bUpdateTableFields)=0
 Updates a field. More...
 
virtual void UpdateRefFields ()=0
 
virtual void UpdateTableFields (const SwTable *pTable)=0
 
virtual void UpdateExpFields (SwTextField *pField, bool bUpdateRefFields)=0
 
virtual void UpdateUsrFields ()=0
 
virtual void UpdatePageFields (const SwTwips)=0
 
virtual void LockExpFields ()=0
 
virtual void UnlockExpFields ()=0
 
virtual bool IsExpFieldsLocked () const =0
 
virtual SwDocUpdateField & GetUpdateFields () const =0
 
virtual bool SetFieldsDirty (bool b, const SwNode *pChk, SwNodeOffset nLen)=0
 
virtual void SetFixFields (const DateTime *pNewDateTime)=0
 
virtual void FieldsToCalc (SwCalc &rCalc, SwNodeOffset nLastNd, sal_Int32 nLastCnt)=0
 
virtual void FieldsToCalc (SwCalc &rCalc, const SetGetExpField &rToThisField, SwRootFrame const *pLayout)=0
 
virtual void FieldsToExpand (SwHashTable< HashStr > &rTable, const SetGetExpField &rToThisField, SwRootFrame const &rLayout)=0
 
virtual bool IsNewFieldLst () const =0
 
virtual void SetNewFieldLst (bool bFlag)=0
 
virtual void InsDelFieldInFieldLst (bool bIns, const SwTextField &rField)=0
 
virtual sal_Int32 GetRecordsPerDocument () const =0
 

Protected Member Functions

virtual ~IDocumentFieldsAccess ()
 

Detailed Description

Document fields related interfaces.

Definition at line 52 of file IDocumentFieldsAccess.hxx.

Constructor & Destructor Documentation

◆ ~IDocumentFieldsAccess()

virtual IDocumentFieldsAccess::~IDocumentFieldsAccess ( )
inlineprotectedvirtual

Definition at line 142 of file IDocumentFieldsAccess.hxx.

Member Function Documentation

◆ FieldsToCalc() [1/2]

virtual void IDocumentFieldsAccess::FieldsToCalc ( SwCalc &  rCalc,
const SetGetExpField &  rToThisField,
SwRootFrame const *  pLayout 
)
pure virtual

Implemented in sw::DocumentFieldsManager.

◆ FieldsToCalc() [2/2]

virtual void IDocumentFieldsAccess::FieldsToCalc ( SwCalc &  rCalc,
SwNodeOffset  nLastNd,
sal_Int32  nLastCnt 
)
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwEditShell::Calculate(), SwGetExpField::ChangeExpansion(), SwDoc::InsertSwSection(), SwUndoDelSection::UndoImpl(), and SwDoc::UpdateSection().

◆ FieldsToExpand()

virtual void IDocumentFieldsAccess::FieldsToExpand ( SwHashTable< HashStr > &  rTable,
const SetGetExpField &  rToThisField,
SwRootFrame const &  rLayout 
)
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwGetExpField::ChangeExpansion().

◆ GetFieldType()

virtual SwFieldType * IDocumentFieldsAccess::GetFieldType ( SwFieldIds  nResId,
const OUString &  rName,
bool  bDbFieldMatching 
) const
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwPostItMgr::AddPostIts(), SwXTextField::attach(), SwTable::CanConvertSubtables(), SwGetExpField::ChangeExpansion(), SwGetRefField::ConvertProgrammaticToUIName(), SwUndoFieldFromDoc::DoImpl(), SwTextShell::ExecField(), SwTextShell::ExecIdx(), SwGetRefFieldType::FindAnchor(), sw::mark::AnnotationMark::GetAnnotationFormatField(), SwXTextFieldMasters::getByName(), SwEditShell::GetFieldType(), SwXTextFieldMasters::hasByName(), SwWrtShell::InsertPostIt(), lcl_GenerateFieldTypeName(), lcl_GetDDEFieldType(), SwXServiceProvider::MakeInstance(), SwFltControlStack::SetAttrInDoc(), UnHide(), SwTOXBaseSection::UpdateAuthorities(), SwTable::UpdateFields(), sw::UpdateFieldsForRedline(), and SwTOXBaseSection::UpdateSequence().

◆ GetFieldTypes()

virtual const SwFieldTypes * IDocumentFieldsAccess::GetFieldTypes ( ) const
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwInputFieldList::BuildSortLst(), SwDoc::ChangeAuthorityData(), SwDoc::ConvertFieldsToText(), SwDoc::dumpAsXml(), SwContentType::FillMemberList(), AttributeOutputBase::GenerateBookmarksForSequenceField(), SwXTextFieldMasters::getElementNames(), SwEditShell::GetFieldType(), SwEditShell::GetFieldTypeCount(), SwXFieldMaster::GetProgrammaticName(), IMPL_LINK_NOARG(), SwEditShell::IsAnyDatabaseFieldInDoc(), SwEditShell::IsFieldDataSourceAvailable(), lcl_InsertDrawLabel(), lcl_InsertLabel(), SwEditShell::RemoveFieldType(), SwDoc::RemoveInvisibleContent(), and SwInputFieldList::SwInputFieldList().

◆ GetRecordsPerDocument()

virtual sal_Int32 IDocumentFieldsAccess::GetRecordsPerDocument ( ) const
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwDBManager::MergeMailFiles().

◆ GetSysFieldType()

virtual SwFieldType * IDocumentFieldsAccess::GetSysFieldType ( const SwFieldIds  eWhich) const
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwViewOptionAdjust_Impl::AdjustViewOptions(), SwXTextField::attach(), SwDoc::ChgDBData(), SwDoc::ChgPageDesc(), SwFEShell::Copy(), SwTextField::CopyTextField(), sw::DocumentStatisticsManager::DocInfoChgd(), SwWW8ImplReader::End_Field(), MSWordExportBase::GatherChapterFields(), SwDoc::HasInvisibleContent(), MSWordExportBase::HasRefToAttr(), MSWordExportBase::HasRefToFootOrEndnote(), sw::IMPL_LINK_NOARG(), sw::DocumentStatisticsManager::IncrementalDocStatCalculate(), SwRefPageGetFieldType::MakeSetList(), SwGetRefFieldType::MergeWithOtherDoc(), SwFEShell::Paste(), SwWW8ImplReader::Read_And(), SwWW8ImplReader::Read_F_Author(), SwWW8ImplReader::Read_F_CurPage(), SwWW8ImplReader::Read_F_DateTime(), SwWW8ImplReader::Read_F_DocInfo(), SwWW8ImplReader::Read_F_Equation(), SwWW8ImplReader::Read_F_FileName(), SwWW8ImplReader::Read_F_FormListBox(), SwWW8ImplReader::Read_F_FormTextBox(), SwWW8ImplReader::Read_F_Input(), SwWW8ImplReader::Read_F_Macro(), SwWW8ImplReader::Read_F_NoteReference(), SwWW8ImplReader::Read_F_Num(), SwWW8ImplReader::Read_F_PgRef(), SwWW8ImplReader::Read_F_Ref(), SwWW8ImplReader::Read_F_Styleref(), SwWW8ImplReader::Read_F_TemplName(), SwWW8ImplReader::ReadChar(), SwWW8FltRefStack::RefToVar(), SwHistorySetTextField::SetInDoc(), sw_GetPostIts(), SwUserFieldType::SwClientNotify(), SwHistorySetTextField::SwHistorySetTextField(), SwTableNumFormatMerge::SwTableNumFormatMerge(), UnHide(), sw::UpdateFieldsForRedline(), and SwNodes::UpdateOutlineNode().

◆ GetUpdateFields()

virtual SwDocUpdateField & IDocumentFieldsAccess::GetUpdateFields ( ) const
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by sw::DocumentTimerManager::GetNextIdleJob(), sw::IMPL_LINK_NOARG(), SwTextInputField::UpdateFieldContent(), and SwCalc::VarLook().

◆ InsDeletedFieldType()

virtual void IDocumentFieldsAccess::InsDeletedFieldType ( SwFieldType &  )
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwTableNode::MakeCopy(), and SwpHints::TryInsertHint().

◆ InsDelFieldInFieldLst()

virtual void IDocumentFieldsAccess::InsDelFieldInFieldLst ( bool  bIns,
const SwTextField &  rField 
)
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwNodes::ChgNode(), SwTextNode::DestroyAttr(), and SwpHints::TryInsertHint().

◆ InsertFieldType()

virtual SwFieldType * IDocumentFieldsAccess::InsertFieldType ( const SwFieldType &  )
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwXTextField::attach(), SwDoc::ChangeDBFields(), SwTextField::CopyTextField(), SwEditShell::InsertFieldType(), SwWW8ImplReader::InsertTagField(), lcl_GetDDEFieldType(), SwTableNode::MakeCopy(), SwTable::MakeCopy(), SwXServiceProvider::MakeInstance(), SwWW8ImplReader::Read_F_ANumber(), SwWW8ImplReader::Read_F_DBField(), SwWW8ImplReader::Read_F_DBNext(), SwWW8ImplReader::Read_F_DBNum(), SwWW8ImplReader::Read_F_InputVar(), SwWW8ImplReader::Read_F_Seq(), SwWW8ImplReader::Read_F_Set(), SwUndoInsTable::RedoImpl(), SwFltControlStack::SetAttrInDoc(), SwHistorySetTextField::SetInDoc(), SwpHints::TryInsertHint(), and SwUndoTableToText::UndoImpl().

◆ IsExpFieldsLocked()

virtual bool IDocumentFieldsAccess::IsExpFieldsLocked ( ) const
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwAuthorityField::ConditionalExpandAuthIdentifier(), SwFEShell::Copy(), SwEditShell::CopySelToDoc(), SwAuthorityField::ExpandCitation(), sw::DocumentTimerManager::GetNextIdleJob(), SwEditShell::IsExpFieldsLocked(), and lcl_CopySelToDoc().

◆ IsNewFieldLst()

virtual bool IDocumentFieldsAccess::IsNewFieldLst ( ) const
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwTextNode::DestroyAttr(), and SwpHints::TryInsertHint().

◆ LockExpFields()

virtual void IDocumentFieldsAccess::LockExpFields ( )
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwDoc::AppendDoc(), SwViewShell::CalcLayout(), SwDoc::ConvertFieldsToText(), SwFEShell::Copy(), SwTransferable::CopyGlossary(), SwEditShell::CopySelToDoc(), SwViewShell::FillPrtDoc(), SwTransferable::GetData(), SwDoc::InsertGlossary(), lcl_CopySelToDoc(), SwEditShell::LockExpFields(), SwFEShell::Paste(), SwFEShell::PastePages(), SwTransferable::PrepareForCopy(), and SwTransferable::PrepareForCopyTextRange().

◆ PutValueToField()

virtual void IDocumentFieldsAccess::PutValueToField ( const SwPosition &  rPos,
const css::uno::Any &  rVal,
sal_uInt16  nWhich 
)
pure virtual

Puts a value into a field at a certain position.

A missing field at the given position leads to a failure.

Parameters
rPositionposition of the field
rValthe value
nMId
Return values
trueputting of value was successful
falseelse

Implemented in sw::DocumentFieldsManager.

Referenced by SwXTextField::setPropertyValue().

◆ RemoveFieldType()

virtual void IDocumentFieldsAccess::RemoveFieldType ( size_t  nField)
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwDBFieldType::ReleaseRef(), and SwEditShell::RemoveFieldType().

◆ SetFieldsDirty()

virtual bool IDocumentFieldsAccess::SetFieldsDirty ( bool  b,
const SwNode *  pChk,
SwNodeOffset  nLen 
)
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwDDETable::ChangeContent(), SwNodes::ChgNode(), SwDoc::DeleteRowCol(), SwDoc::DelTable(), SwDoc::InsCopyOfTable(), SwDoc::InsertCol(), SwDoc::InsertRow(), SwDoc::MergeTable(), SwXTextDocument::setPropertyValue(), SwDoc::SetTableAutoFormat(), SwDoc::SplitTable(), SwTableBoxFormat::SwClientNotify(), SwTextFrame::SwClientNotify(), and SwDoc::TextToTable().

◆ SetFixFields()

virtual void IDocumentFieldsAccess::SetFixFields ( const DateTime *  pNewDateTime)
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwDoc::InsertGlossary(), SwModule::Notify(), and Reader::SetTemplate().

◆ SetNewFieldLst()

virtual void IDocumentFieldsAccess::SetNewFieldLst ( bool  bFlag)
pure virtual

Implemented in sw::DocumentFieldsManager.

◆ UnlockExpFields()

virtual void IDocumentFieldsAccess::UnlockExpFields ( )
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwDoc::AppendDoc(), SwViewShell::CalcLayout(), SwDoc::ConvertFieldsToText(), SwFEShell::Copy(), SwEditShell::CopySelToDoc(), SwDoc::InsertGlossary(), lcl_CopySelToDoc(), SwFEShell::Paste(), SwFEShell::PastePages(), and SwEditShell::UnlockExpFields().

◆ UpdateExpFields()

virtual void IDocumentFieldsAccess::UpdateExpFields ( SwTextField *  pField,
bool  bUpdateRefFields 
)
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwViewShell::CalcLayout(), SwFEShell::Copy(), SwEditShell::CopySelToDoc(), SwTextField::CopyTextField(), sw::IMPL_LINK_NOARG(), SwDoc::InsertGlossary(), lcl_CopySelToDoc(), SwDoc::SetOutlineNumRule(), UnHide(), SwEditShell::UpdateExpFields(), and sw::UpdateFieldsForRedline().

◆ UpdateField()

virtual bool IDocumentFieldsAccess::UpdateField ( SwTextField *  rDstFormatField,
SwField &  rSrcField,
bool  bUpdateTableFields 
)
pure virtual

Updates a field.

Parameters
rDstFormatFieldfield to update
rSrcFieldfield containing the new values
pMsgHint
bUpdateTableFieldsTRUE: update table fields, too.
Return values
trueupdate was successful
falseelse

Implemented in sw::DocumentFieldsManager.

Referenced by SwUndoFieldFromDoc::DoImpl(), SwUndoFieldFromDoc::UndoImpl(), and SwEditShell::UpdateOneField().

◆ UpdateFields()

virtual void IDocumentFieldsAccess::UpdateFields ( bool  bCloseDB)
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwDoc::AppendDoc(), SwFEShell::Copy(), SwFEShell::Paste(), SwFEShell::PastePages(), SwXTextFieldTypes::refresh(), and SwViewShell::UpdateFields().

◆ UpdatePageFields()

virtual void IDocumentFieldsAccess::UpdatePageFields ( const  SwTwips)
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwViewShell::CalcLayout(), SwFrame::CheckPageDescs(), SwRootFrame::Init(), SwFrame::InsertPage(), SwRootFrame::RemoveSuperfluous(), SwContentFrame::UpdateAttr_(), and SwTabFrame::UpdateAttr_().

◆ UpdateRefFields()

virtual void IDocumentFieldsAccess::UpdateRefFields ( )
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by sw::IMPL_LINK_NOARG(), SwRootFrame::Init(), SwDoc::SetEndNoteInfo(), SwDoc::SetFootnoteInfo(), UnHide(), and sw::UpdateFieldsForRedline().

◆ UpdateTableFields()

virtual void IDocumentFieldsAccess::UpdateTableFields ( const SwTable *  pTable)
pure virtual

Implemented in sw::DocumentFieldsManager.

Referenced by SwDoc::ChkBoxNumFormat(), sw::IMPL_LINK_NOARG(), SwUndoTableNumFormat::RedoImpl(), SwXCell::setFormula(), and SwEditShell::UpdateTable().

◆ UpdateUsrFields()

virtual void IDocumentFieldsAccess::UpdateUsrFields ( )
pure virtual

Implemented in sw::DocumentFieldsManager.

The documentation for this class was generated from the following file:
Generated on Sun Jul 30 2023 04:30:43 for LibreOffice Module sw (master) by doxygen 1.9.3