LibreOffice Module sw (master) 1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
SwTOXBaseSection Class Referencefinal

#include <doctxm.hxx>

Inheritance diagram for SwTOXBaseSection:
Collaboration diagram for SwTOXBaseSection:

Public Member Functions

 SwTOXBaseSection (SwTOXBase const &rBase, SwSectionFormat &rFormat)
virtual ~SwTOXBaseSection () override
void Update (const SfxItemSet *pAttr=nullptr, SwRootFrame const *pLayout=nullptr, const bool _bNewTOX=false)
 Collect table of contents content. More...
void UpdatePageNum ()
 Calculate PageNumber and insert after formatting. More...
bool SetPosAtStartEnd (SwPosition &rPos) const
bool IsVisible () const override
- Public Member Functions inherited from SwTOXBase
 SwTOXBase (const SwTOXType *pTyp, const SwForm &rForm, SwTOXElement nCreaType, OUString aTitle)
 SwTOXBase (const SwTOXBase &rCopy, SwDoc *pDoc=nullptr)
virtual ~SwTOXBase () override
virtual void SwClientNotify (const SwModify &rMod, const SfxHint &rHint) override
void CopyTOXBase (SwDoc *, const SwTOXBase &)
const SwTOXTypeGetTOXType () const
SwTOXElement GetCreateType () const
const OUString & GetTOXName () const
void SetTOXName (const OUString &rSet)
const OUString & GetMSTOCExpression () const
void SetMSTOCExpression (const OUString &rExp)
void EnableKeepExpression ()
void DisableKeepExpression ()
const OUString & GetTitle () const
const OUString & GetBookmarkName () const
OUString const & GetTypeName () const
const SwFormGetTOXForm () const
void SetCreate (SwTOXElement)
void SetTitle (const OUString &rTitle)
void SetTOXForm (const SwForm &rForm)
void SetBookmarkName (const OUString &bName)
TOXTypes GetType () const
const OUString & GetMainEntryCharStyle () const
void SetMainEntryCharStyle (const OUString &rSet)
void SetLevel (sal_uInt16)
sal_uInt16 GetLevel () const
SwTOIOptions GetOptions () const
void SetOptions (SwTOIOptions nOpt)
SwTOOElements GetOLEOptions () const
void SetOLEOptions (SwTOOElements nOpt)
OUString const & GetStyleNames (sal_uInt16 nLevel) const
void SetStyleNames (const OUString &rSet, sal_uInt16 nLevel)
bool IsFromChapter () const
void SetFromChapter (bool bSet)
bool IsFromObjectNames () const
void SetFromObjectNames (bool bSet)
bool IsLevelFromChapter () const
void SetLevelFromChapter (bool bSet)
bool IsProtected () const
void SetProtected (bool bSet)
const OUString & GetSequenceName () const
void SetSequenceName (const OUString &rSet)
SwCaptionDisplay GetCaptionDisplay () const
void SetCaptionDisplay (SwCaptionDisplay eSet)
bool IsTOXBaseInReadonly () const
const SfxItemSetGetAttrSet () const
void SetAttrSet (const SfxItemSet &)
LanguageType GetLanguage () const
void SetLanguage (LanguageType nLang)
const OUString & GetSortAlgorithm () const
void SetSortAlgorithm (const OUString &rSet)
void AdjustTabStops (SwDoc const &rDoc)
SwTOXBaseoperator= (const SwTOXBase &rSource)
void RegisterToTOXType (SwTOXType &rMark)
virtual bool IsVisible () const
- Public Member Functions inherited from SwClient
 SwClient ()
 SwClient (SwClient &&) noexcept
virtual ~SwClient () override
std::optional< sw::ModifyChangedHintCheckRegistration (const SfxPoolItem *pOldValue)
void CheckRegistrationFormat (SwFormat &rOld)
const SwModifyGetRegisteredIn () const
SwModifyGetRegisteredIn ()
void EndListeningAll ()
void StartListeningToSameModifyAs (const SwClient &)
virtual bool GetInfo (SfxPoolItem &) const
- Public Member Functions inherited from sw::WriterListener
bool IsLast () const
virtual const SwCellFrameDynCastCellFrame () const
virtual const SwTabFrameDynCastTabFrame () const
virtual const SwRowFrameDynCastRowFrame () const
virtual const SwTableDynCastTable () const
- Public Member Functions inherited from SwSection
 SwSection (SectionType const eType, OUString const &rName, SwSectionFormat &rFormat)
virtual ~SwSection () override
bool DataEquals (SwSectionData const &rCmp) const
void SetSectionData (SwSectionData const &rData)
const OUString & GetSectionName () const
void SetSectionName (OUString const &rName)
SectionType GetType () const
void SetType (SectionType const eType)
SwSectionFormatGetFormat ()
SwSectionFormat const * GetFormat () const
bool IsHidden () const
void SetHidden (bool const bFlag=true)
bool IsProtect () const
void SetProtect (bool const bFlag=true)
bool IsEditInReadonly () const
void SetEditInReadonly (bool const bFlag=true)
bool IsHiddenFlag () const
bool IsProtectFlag () const
bool IsEditInReadonlyFlag () const
void SetCondHidden (bool const bFlag)
bool IsCondHidden () const
bool CalcHiddenFlag () const
SwSectionGetParent () const
OUString const & GetCondition () const
void SetCondition (OUString const &rNew)
OUString const & GetLinkFileName () const
void SetLinkFileName (OUString const &rNew)
OUString const & GetLinkFilePassword () const
void SetLinkFilePassword (OUString const &rS)
css::uno::Sequence< sal_Int8 > const & GetPassword () const
void SetRefObject (SwServerObject *pObj)
const SwServerObjectGetObject () const
SwServerObjectGetObject ()
bool IsServer () const
SfxLinkUpdateMode GetUpdateType () const
void SetUpdateType (SfxLinkUpdateMode nType)
bool IsConnected () const
void UpdateNow ()
void Disconnect ()
const ::sfx2::SvBaseLinkGetBaseLink () const
::sfx2::SvBaseLinkGetBaseLink ()
void CreateLink (LinkCreateType eType)
bool IsLinkType () const
bool IsConnectFlag () const
void SetConnectFlag (bool const bFlag=true)
const SwTOXBaseGetTOXBase () const
void BreakLink ()
void dumpAsXml (xmlTextWriterPtr pWriter) const
- Public Member Functions inherited from SvtListener
 SvtListener ()=default
 SvtListener (const SvtListener &r)=default
virtual ~SvtListener () COVERITY_NOEXCEPT_FALSE
bool StartListening (SvtBroadcaster &rBroadcaster)
void EndListening (SvtBroadcaster &rBroadcaster)
void EndListeningAll ()
void CopyAllBroadcasters (const SvtListener &r)
bool HasBroadcaster () const
virtual void Notify (const SfxHint &rHint)
virtual void Query (QueryBase &rQuery) const

Private Member Functions

void UpdateMarks (const SwTOXInternational &rIntl, const SwTextNode *pOwnChapterNode, SwRootFrame const *pLayout)
 Create from Marks. More...
void UpdateOutline (const SwTextNode *pOwnChapterNode, SwRootFrame const *pLayout)
 Generate table of contents from outline. More...
void UpdateTemplate (const SwTextNode *pOwnChapterNode, SwRootFrame const *pLayout)
 Generate table of contents from template areas. More...
void UpdateContent (SwTOXElement eType, const SwTextNode *pOwnChapterNode, SwRootFrame const *pLayout)
void UpdateTable (const SwTextNode *pOwnChapterNode, SwRootFrame const *pLayout)
 Collect table entries. More...
void UpdateSequence (const SwTextNode *pOwnChapterNode, SwRootFrame const *pLayout)
 Generate content from sequence fields. More...
void UpdateAuthorities (const SwTOXInternational &rIntl, SwRootFrame const *pLayout)
void InsertSorted (std::unique_ptr< SwTOXSortTabBase > pBase)
void InsertAlphaDelimiter (const SwTOXInternational &rIntl)
void UpdatePageNum_ (SwTextNode *pNd, const std::vector< sal_uInt16 > &rNums, const std::vector< SwPageDesc * > &rDescs, const std::vector< sal_uInt16 > *pMainEntryNums, const SwTOXInternational &rIntl)
Range GetKeyRange (const OUString &rStr, const OUString &rStrReading, const SwTOXSortTabBase &rNew, sal_uInt16 nLevel, const Range &rRange)
 Find Key Range and insert if possible. More...
SwTextFormatCollGetTextFormatColl (sal_uInt16 nLevel)
 Evaluate Template. More...
virtual void SwClientNotify (const SwModify &rModify, const SfxHint &rHint) override

Private Attributes

std::vector< std::unique_ptr< SwTOXSortTabBase > > m_aSortArr

Additional Inherited Members

- Static Public Member Functions inherited from SwSection
static void MakeChildLinksVisible (const SwSectionNode &rSectNd)
- Protected Member Functions inherited from SwClient
 SwClient (SwModify *pToRegisterIn)
SwModifyGetRegisteredInNonConst () const
virtual void SwClientNotify (const SwModify &, const SfxHint &rHint) override
- Protected Member Functions inherited from sw::WriterListener
 WriterListener ()
virtual ~WriterListener () COVERITY_NOEXCEPT_FALSE
virtual void SwClientNotify (const SwModify &, const SfxHint &rHint)=0
- Protected Member Functions inherited from SwSection
virtual void Notify (SfxHint const &rHint) override
virtual void SwClientNotify (const SwModify &, const SfxHint &) override
- Protected Attributes inherited from SwTOXBase
OUString maMSTOCExpression
bool mbKeepExpression

Detailed Description

Definition at line 35 of file doctxm.hxx.

Constructor & Destructor Documentation

◆ SwTOXBaseSection()

SwTOXBaseSection::SwTOXBaseSection ( SwTOXBase const &  rBase,
SwSectionFormat rFormat 

◆ ~SwTOXBaseSection()

SwTOXBaseSection::~SwTOXBaseSection ( )

Definition at line 835 of file doctxm.cxx.

Member Function Documentation

◆ GetKeyRange()

Range SwTOXBaseSection::GetKeyRange ( const OUString &  rStr,
const OUString &  rStrReading,
const SwTOXSortTabBase rNew,
sal_uInt16  nLevel,
const Range rRange 

◆ GetTextFormatColl()

SwTextFormatColl * SwTOXBaseSection::GetTextFormatColl ( sal_uInt16  nLevel)

◆ InsertAlphaDelimiter()

void SwTOXBaseSection::InsertAlphaDelimiter ( const SwTOXInternational rIntl)

◆ InsertSorted()

void SwTOXBaseSection::InsertSorted ( std::unique_ptr< SwTOXSortTabBase pBase)

◆ IsVisible()

bool SwTOXBaseSection::IsVisible ( ) const

Reimplemented from SwTOXBase.

Definition at line 90 of file doctxm.hxx.

References SwSection::GetFormat(), and SwSectionFormat::IsVisible().

◆ SetPosAtStartEnd()

bool SwTOXBaseSection::SetPosAtStartEnd ( SwPosition rPos) const

◆ SwClientNotify()

void SwTOXBaseSection::SwClientNotify ( const SwModify rModify,
const SfxHint rHint 

◆ Update()

void SwTOXBaseSection::Update ( const SfxItemSet pAttr = nullptr,
SwRootFrame const *  pLayout = nullptr,
const bool  _bNewTOX = false 

Collect table of contents content.

Definition at line 853 of file doctxm.cxx.

References aBreakSetRange, AlphaDelimiter, SwFrame::CheckPageDescs(), SwDoc::ChgFormat(), SwDoc::CorrAbs(), SfxItemSet::Count(), SwNodes::Delete(), IDocumentRedlineAccess::DeleteRedline(), DelFlyInRange(), SwNode::EndOfSectionIndex(), SwNode::EndOfSectionNode(), SwNode::FindPageDesc(), SwNode::FindSectionNode(), fnMoveBackward, fnMoveForward, FORM_TITLE, Frame, sw::ToxTextGenerator::GenerateText(), sw::DocumentSettingManager::get(), SwDoc::GetAllLayouts(), SwDoc::GetAttrPool(), SvxFormatBreakItem::GetBreak(), SwAttrSet::GetBreak(), SwNode::GetContentNode(), SwTOXBase::GetCreateType(), SwNode::GetDoc(), SwDoc::GetDocShell(), SwDoc::GetDocumentSettingManager(), SwNodes::GetEndOfContent(), SwSection::GetFormat(), SwDoc::getIDocumentRedlineAccess(), SwDoc::getIDocumentState(), SwDoc::getIDocumentStylePoolAccess(), SwDoc::GetIDocumentUndoRedo(), SwNodeIndex::GetIndex(), SwNode::GetIndex(), SwTOXBase::GetLanguage(), SwNodeIndex::GetNode(), GetNode(), SwDoc::GetNodes(), SwNode::GetNodes(), SwTOXBase::GetOptions(), SwFormatPageDesc::GetPageDesc(), SwFormat::GetPageDesc(), SwDoc::GetPageDesc(), SwPaM::GetPoint(), SwTOXMark::GetPrimaryKey(), SwContentNode::GetpSwAttrSet(), SwNode::GetRedlineMergeFlag(), SwTOXMark::GetSecondaryKey(), SwSectionNode::GetSection(), SwNode::GetSectionLevel(), SwTOXBase::GetSequenceName(), SwTOXBase::GetSortAlgorithm(), SwContentNode::GetSwAttrSet(), IDocumentStylePoolAccess::GetTextCollFromPool(), GetTextFormatColl(), SwTOXBase::GetTitle(), SwTOXBase::GetTOXForm(), SwTOXBase::GetTOXName(), SwTOXBase::GetTOXType(), SwSection::GetType(), SwTOXBase::GetType(), SwNodes::GoNext(), SwNodes::GoPrevious(), Graphic, SwRootFrame::HasMergedParas(), SwContentNode::HasSwAttrSet(), SwNode::Hidden, InsertAlphaDelimiter(), SwTextNode::InsertText(), SwNodes::InsertTextSection(), SwNodes::IsDocNodes(), SwTOXBase::IsFromChapter(), SwTOXBase::IsFromObjectNames(), SwSection::IsHiddenFlag(), SwTOXBase::IsProtected(), lcl_FindChapterNode(), m_aSortArr, SwDoc::MakeSectionFormat(), SwNodes::MakeTextNode(), SwTOXBase::maMSTOCExpression, Mark, SwTOXBase::mbKeepExpression, SwPaM::Move(), NONE, Ole, OutlineLevel, SfxItemSet::Put(), RES_POOLCOLL_TEXT, SwNode2LayoutSaveUpperFrames::RestoreUpperFrames(), SwContentNode::SetAttr(), SwTextNode::SetAttr(), IDocumentState::SetModified(), SetProgressState(), SwSection::SetProtect(), SwNode::StartOfSectionIndex(), Table, TABS_RELATIVE_TO_INDENT, sw::DefaultToxTabStopTokenHandler::TABSTOPS_RELATIVE_TO_INDENT, sw::DefaultToxTabStopTokenHandler::TABSTOPS_RELATIVE_TO_PAGE, Template, SwUndoUpdateIndex::TitleSectionInserted(), TOX_AUTHORITIES, TOX_ILLUSTRATIONS, TOX_INDEX, TOX_OBJECTS, TOX_SORT_INDEX, TOX_TABLES, ToxHeader, UpdateAuthorities(), UpdateContent(), UpdateMarks(), SwDoc::UpdateNumRule(), UpdateOutline(), UpdateSequence(), UpdateTable(), and UpdateTemplate().

Referenced by SwDoc::InsertTableOf(), SwXDocumentIndex::refresh(), and SwEditShell::UpdateTableOf().

◆ UpdateAuthorities()

void SwTOXBaseSection::UpdateAuthorities ( const SwTOXInternational rIntl,
SwRootFrame const *  pLayout 

◆ UpdateContent()

void SwTOXBaseSection::UpdateContent ( SwTOXElement  eType,
const SwTextNode pOwnChapterNode,
SwRootFrame const *  pLayout 

◆ UpdateMarks()

void SwTOXBaseSection::UpdateMarks ( const SwTOXInternational rIntl,
const SwTextNode pOwnChapterNode,
SwRootFrame const *  pLayout 

◆ UpdateOutline()

void SwTOXBaseSection::UpdateOutline ( const SwTextNode pOwnChapterNode,
SwRootFrame const *  pLayout 

◆ UpdatePageNum()

void SwTOXBaseSection::UpdatePageNum ( )

◆ UpdatePageNum_()

void SwTOXBaseSection::UpdatePageNum_ ( SwTextNode pNd,
const std::vector< sal_uInt16 > &  rNums,
const std::vector< SwPageDesc * > &  rDescs,
const std::vector< sal_uInt16 > *  pMainEntryNums,
const SwTOXInternational rIntl 

◆ UpdateSequence()

void SwTOXBaseSection::UpdateSequence ( const SwTextNode pOwnChapterNode,
SwRootFrame const *  pLayout 

◆ UpdateTable()

void SwTOXBaseSection::UpdateTable ( const SwTextNode pOwnChapterNode,
SwRootFrame const *  pLayout 

◆ UpdateTemplate()

void SwTOXBaseSection::UpdateTemplate ( const SwTextNode pOwnChapterNode,
SwRootFrame const *  pLayout 

Member Data Documentation

◆ m_aSortArr

std::vector<std::unique_ptr<SwTOXSortTabBase> > SwTOXBaseSection::m_aSortArr

Definition at line 37 of file doctxm.hxx.

Referenced by GetKeyRange(), InsertAlphaDelimiter(), InsertSorted(), Update(), and UpdatePageNum().

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