LibreOffice Module sw (master): SwTOXMgr Class Reference

LibreOffice Module sw (master) 1

Built on top of SwWrtShell, provides functionality to insert, update or perform other actions on various ToX types (table of contents, indexes and so on). More...

#include <toxmgr.hxx>

Collaboration diagram for SwTOXMgr:

Public Member Functions
	SwTOXMgr (SwWrtShell *pShell)

void	InsertTOXMark (const SwTOXMarkDescription &rDesc)

void	UpdateTOXMark (const SwTOXMarkDescription &rDesc)

void	DeleteTOXMark ()

void	NextTOXMark (bool bSame=false)

void	PrevTOXMark (bool bSame=false)

sal_uInt16	GetTOXMarkCount () const

SwTOXMark *	GetTOXMark (sal_uInt16 nId)

SwTOXMark *	GetCurTOXMark ()

void	SetCurTOXMark (sal_uInt16 nId)

bool	UpdateOrInsertTOX (const SwTOXDescription &rDesc, SwTOXBase *ppBase, const SfxItemSet pSet)

const SwTOXType *	GetTOXType (TOXTypes eTyp) const

SwWrtShell *	GetShell ()

Private Member Functions
SAL_DLLPRIVATE sal_uInt16	GetUserTypeID (const OUString &rStr)

Private Attributes
SwWrtShell *	m_pSh

SwTOXMark *	m_pCurTOXMark

SwTOXMarks	m_aCurMarks

Detailed Description

Built on top of SwWrtShell, provides functionality to insert, update or perform other actions on various ToX types (table of contents, indexes and so on).

Definition at line 230 of file toxmgr.hxx.

Constructor & Destructor Documentation

◆ SwTOXMgr()

SwTOXMgr::SwTOXMgr ( SwWrtShell * pShell )

explicit

Definition at line 30 of file toxmgr.cxx.

References SwEditShell::GetCurTOXMarks(), m_aCurMarks, m_pSh, and SetCurTOXMark().

Member Function Documentation

◆ DeleteTOXMark()

void SwTOXMgr::DeleteTOXMark ( )

Definition at line 44 of file toxmgr.cxx.

References SwEditShell::DeleteTOXMark(), SwCursorShell::GotoTOXMark(), m_pCurTOXMark, m_pSh, SwEditShell::SetModified(), and TOX_NXT.

◆ GetCurTOXMark()

SwTOXMark * SwTOXMgr::GetCurTOXMark ( )

inline

Definition at line 270 of file toxmgr.hxx.

References m_pCurTOXMark.

Referenced by SwTextShell::ExecIdx().

◆ GetShell()

SwWrtShell * SwTOXMgr::GetShell ( )

inline

Definition at line 263 of file toxmgr.hxx.

Referenced by SwMultiTOXMarkDlg::SwMultiTOXMarkDlg().

◆ GetTOXMark()

SwTOXMark * SwTOXMgr::GetTOXMark ( sal_uInt16 nId )

Definition at line 37 of file toxmgr.cxx.

References m_aCurMarks, and nId.

Referenced by SwMultiTOXMarkDlg::SwMultiTOXMarkDlg().

◆ GetTOXMarkCount()

sal_uInt16 SwTOXMgr::GetTOXMarkCount ( ) const

inline

Definition at line 267 of file toxmgr.hxx.

References m_aCurMarks.

Referenced by SwTextShell::ExecIdx(), and SwMultiTOXMarkDlg::SwMultiTOXMarkDlg().

◆ GetTOXType()

const SwTOXType * SwTOXMgr::GetTOXType ( TOXTypes eTyp ) const

Definition at line 257 of file toxmgr.cxx.

References SwEditShell::GetTOXType(), and m_pSh.

◆ GetUserTypeID()

sal_uInt16 SwTOXMgr::GetUserTypeID ( const OUString & rStr )

private

Definition at line 222 of file toxmgr.cxx.

References SwViewShell::GetDoc(), SwEditShell::GetTOXType(), SwEditShell::GetTOXTypeCount(), SwTOXType::GetTypeName(), i, SwEditShell::InsertTOXType(), m_pSh, and TOX_USER.

Referenced by InsertTOXMark().

◆ InsertTOXMark()

void SwTOXMgr::InsertTOXMark ( const SwTOXMarkDescription & rDesc )

Definition at line 60 of file toxmgr.cxx.

References SwEditShell::EndAllAction(), SwTOXMarkDescription::GetAltStr(), SwTOXMarkDescription::GetLevel(), SwTOXMarkDescription::GetPhoneticReadingOfAltStr(), SwTOXMarkDescription::GetPhoneticReadingOfPrimKey(), SwTOXMarkDescription::GetPhoneticReadingOfSecKey(), SwTOXMarkDescription::GetPrimKey(), SwTOXMarkDescription::GetSecKey(), SwTOXMarkDescription::GetTOUName(), SwTOXMarkDescription::GetTOXType(), SwEditShell::GetTOXType(), GetUserTypeID(), SwTOXMarkDescription::IsMainEntry(), m_pSh, MAXLEVEL, nId, SwTOXMark::SetAlternativeText(), SwTOXMark::SetLevel(), SwTOXMark::SetMainEntry(), SwTOXMark::SetPrimaryKey(), SwTOXMark::SetPrimaryKeyReading(), SwTOXMark::SetSecondaryKey(), SwTOXMark::SetSecondaryKeyReading(), SwTOXMark::SetTextReading(), SwEditShell::StartAllAction(), TOX_BIBLIOGRAPHY, TOX_CONTENT, TOX_INDEX, and TOX_USER.

Referenced by SwIndexMarkPane::InsertMark().

◆ NextTOXMark()

void SwTOXMgr::NextTOXMark ( bool bSame = false )

Definition at line 237 of file toxmgr.cxx.

References SwCursorShell::GotoTOXMark(), m_pCurTOXMark, m_pSh, TOX_NXT, and TOX_SAME_NXT.

◆ PrevTOXMark()

void SwTOXMgr::PrevTOXMark ( bool bSame = false )

Definition at line 247 of file toxmgr.cxx.

References SwCursorShell::GotoTOXMark(), m_pCurTOXMark, m_pSh, TOX_PRV, and TOX_SAME_PRV.

◆ SetCurTOXMark()

void SwTOXMgr::SetCurTOXMark ( sal_uInt16 nId )

Definition at line 262 of file toxmgr.cxx.

References m_aCurMarks, m_pCurTOXMark, and nId.

Referenced by SwMultiTOXMarkDlg::run(), SwTOXMgr(), and UpdateTOXMark().

◆ UpdateOrInsertTOX()

bool SwTOXMgr::UpdateOrInsertTOX	(	const SwTOXDescription &	rDesc,
		SwTOXBase **	ppBase,
		const SfxItemSet *	pSet
	)

TODO

Definition at line 267 of file toxmgr.cxx.

References SwEditShell::ApplyAutoMark(), SwDoc::ChangeTOX(), SwTOXBase::DisableKeepExpression(), SwTOXBase::EnableKeepExpression(), SwWrtShell::EnterStdMode(), SwTOXDescription::GetAuthBrackets(), SwTOXDescription::GetAutoMarkURL(), SwTOXDescription::GetCaptionDisplay(), SwTOXDescription::GetContentOptions(), SwEditShell::GetCurTOX(), SwViewShell::GetDoc(), SwView::GetDocShell(), SwEditShell::GetFieldType(), SwTOXDescription::GetForm(), SwDoc::GetIDocumentUndoRedo(), SwTOXDescription::GetIndexOptions(), SwTOXDescription::GetLanguage(), SwTOXDescription::GetLevel(), SwTOXDescription::GetMainEntryCharStyle(), SwTOXDescription::GetOLEOptions(), SwTOXDescription::GetSequenceName(), SwTOXDescription::GetSortAlgorithm(), SwTOXDescription::GetSortKey1(), SwTOXDescription::GetSortKey2(), SwTOXDescription::GetSortKey3(), SwTOXDescription::GetStyleNames(), SwTOXDescription::GetTitle(), SwTOXDescription::GetTOUName(), SwTOXDescription::GetTOXType(), SwEditShell::GetTOXType(), SwEditShell::GetTOXTypeCount(), SwTOXType::GetTypeName(), SwWrtShell::GetView(), SwWrtShell::HasSelection(), i, SwEditShell::InsertFieldType(), SwWrtShell::InsertTableOf(), SwTOXDescription::IsAuthSequence(), SwTOXDescription::IsCreateFromObjectNames(), SwTOXDescription::IsFromChapter(), SwTOXDescription::IsLevelFromChapter(), SwTOXDescription::IsReadonly(), SwTOXDescription::IsSortByDocument(), m_pSh, Mark, MAXLEVEL, NONE, nPos, SwTOXBase::SetCaptionDisplay(), SwTOXBase::SetCreate(), SwTOXBase::SetFromChapter(), SwTOXBase::SetFromObjectNames(), SwAuthorityFieldType::SetLanguage(), SwTOXBase::SetLanguage(), SwTOXBase::SetLevel(), SwTOXBase::SetLevelFromChapter(), SwTOXBase::SetMainEntryCharStyle(), SwTOXBase::SetOLEOptions(), SwTOXBase::SetOptions(), SwAuthorityFieldType::SetPreSuffix(), SwTOXBase::SetProtected(), SwAuthorityFieldType::SetSequence(), SwTOXBase::SetSequenceName(), SwAuthorityFieldType::SetSortAlgorithm(), SwTOXBase::SetSortAlgorithm(), SwAuthorityFieldType::SetSortByDocument(), SwAuthorityFieldType::SetSortKeys(), SwTOXBase::SetStyleNames(), SwTOXBase::SetTitle(), SwEditShell::SetTOIAutoMarkURL(), SwTOXBase::SetTOXForm(), TableOfAuthorities, TOX_AUTHORITIES, TOX_BIBLIOGRAPHY, TOX_CITATION, TOX_CONTENT, TOX_ILLUSTRATIONS, TOX_INDEX, TOX_OBJECTS, TOX_TABLES, TOX_USER, TOXCHANGE, type, SwFieldType::UpdateFields(), and SwWrtShell::UpdateTableOf().

Referenced by SwGlobalTree::ExecuteContextMenuAction().

◆ UpdateTOXMark()

void SwTOXMgr::UpdateTOXMark ( const SwTOXMarkDescription & rDesc )

Definition at line 149 of file toxmgr.cxx.

References Chars, SwEditShell::DeleteTOXMark(), SwEditShell::EndAllAction(), SwTOXMarkDescription::GetAltStr(), SwEditShell::GetCurTOXMarks(), SwTOXMarkDescription::GetLevel(), SwTOXMarkDescription::GetPhoneticReadingOfAltStr(), SwTOXMarkDescription::GetPhoneticReadingOfPrimKey(), SwTOXMarkDescription::GetPhoneticReadingOfSecKey(), SwTOXMarkDescription::GetPrimKey(), SwTOXMarkDescription::GetSecKey(), SwTOXMark::GetTOXType(), SwTOXType::GetType(), SwTOXMark::IsAlternativeText(), SwTOXMarkDescription::IsMainEntry(), SwWrtShell::Left(), m_aCurMarks, m_pCurTOXMark, m_pSh, SwTOXMark::SetAlternativeText(), SetCurTOXMark(), SwTOXMark::SetLevel(), SwTOXMark::SetMainEntry(), SwEditShell::SetModified(), SwTOXMark::SetPrimaryKey(), SwTOXMark::SetPrimaryKeyReading(), SwTOXMark::SetSecondaryKey(), SwTOXMark::SetSecondaryKeyReading(), SwTOXMark::SetTextReading(), SwEditShell::StartAllAction(), and TOX_INDEX.

Member Data Documentation

◆ m_aCurMarks

SwTOXMarks SwTOXMgr::m_aCurMarks

private

Definition at line 234 of file toxmgr.hxx.

Referenced by GetTOXMark(), GetTOXMarkCount(), SetCurTOXMark(), SwTOXMgr(), and UpdateTOXMark().

◆ m_pCurTOXMark

SwTOXMark* SwTOXMgr::m_pCurTOXMark

private

Definition at line 233 of file toxmgr.hxx.

Referenced by DeleteTOXMark(), GetCurTOXMark(), NextTOXMark(), PrevTOXMark(), SetCurTOXMark(), and UpdateTOXMark().

◆ m_pSh

SwWrtShell* SwTOXMgr::m_pSh

private

Definition at line 232 of file toxmgr.hxx.

Referenced by DeleteTOXMark(), GetTOXType(), GetUserTypeID(), InsertTOXMark(), NextTOXMark(), PrevTOXMark(), SwTOXMgr(), UpdateOrInsertTOX(), and UpdateTOXMark().

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