LibreOffice Module sw (master) 1
Public Member Functions | Protected Attributes | Private Attributes | List of all members
SwTOXBase Class Reference

#include <tox.hxx>

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

Public Member Functions

 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
 

Protected Attributes

OUString maMSTOCExpression
 
bool mbKeepExpression
 

Private Attributes

SwForm m_aForm
 
OUString m_aName
 
OUString m_aTitle
 
OUString m_aBookmarkName
 
OUString m_sMainEntryCharStyle
 
OUString m_aStyleNames [MAXLEVEL]
 
OUString m_sSequenceName
 
LanguageType m_eLanguage
 
OUString m_sSortAlgorithm
 
union {
   sal_uInt16   nLevel
 
   SwTOIOptions   nOptions
 
m_aData
 
SwTOXElement m_nCreateType
 
SwTOOElements m_nOLEOptions
 
SwCaptionDisplay m_eCaptionDisplay
 
bool m_bProtected: 1
 
bool m_bFromChapter: 1
 
bool m_bFromObjectNames: 1
 
bool m_bLevelFromChapter: 1
 

Additional Inherited Members

- 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
 

Detailed Description

Definition at line 425 of file tox.hxx.

Constructor & Destructor Documentation

◆ SwTOXBase() [1/2]

SwTOXBase::SwTOXBase ( const SwTOXType pTyp,
const SwForm rForm,
SwTOXElement  nCreaType,
OUString  aTitle 
)

Definition at line 535 of file tox.cxx.

References m_aData, and NONE.

◆ SwTOXBase() [2/2]

SwTOXBase::SwTOXBase ( const SwTOXBase rCopy,
SwDoc pDoc = nullptr 
)

Definition at line 554 of file tox.cxx.

References CopyTOXBase().

◆ ~SwTOXBase()

SwTOXBase::~SwTOXBase ( )
overridevirtual

Definition at line 623 of file tox.cxx.

Member Function Documentation

◆ AdjustTabStops()

void SwTOXBase::AdjustTabStops ( SwDoc const &  rDoc)
inline

Definition at line 558 of file tox.hxx.

References SwForm::AdjustTabStops().

◆ CopyTOXBase()

void SwTOXBase::CopyTOXBase ( SwDoc pDoc,
const SwTOXBase rSource 
)

◆ DisableKeepExpression()

void SwTOXBase::DisableKeepExpression ( )
inline

Definition at line 488 of file tox.hxx.

Referenced by SwTOXMgr::UpdateOrInsertTOX().

◆ EnableKeepExpression()

void SwTOXBase::EnableKeepExpression ( )
inline

Definition at line 487 of file tox.hxx.

Referenced by SwTOXMgr::UpdateOrInsertTOX().

◆ GetAttrSet()

const SfxItemSet * SwTOXBase::GetAttrSet ( ) const

Definition at line 2117 of file doctxm.cxx.

References SwFormat::GetAttrSet(), and SwSection::GetFormat().

Referenced by SwTextShell::ExecIdx(), and operator=().

◆ GetBookmarkName()

const OUString & SwTOXBase::GetBookmarkName ( ) const
inline

Definition at line 707 of file tox.hxx.

References m_aBookmarkName.

Referenced by SwXDocumentIndex::getPropertyValue().

◆ GetCaptionDisplay()

SwCaptionDisplay SwTOXBase::GetCaptionDisplay ( ) const
inline

◆ GetCreateType()

SwTOXElement SwTOXBase::GetCreateType ( ) const
inline

◆ GetLanguage()

LanguageType SwTOXBase::GetLanguage ( ) const
inline

◆ GetLevel()

sal_uInt16 SwTOXBase::GetLevel ( ) const
inline

◆ GetMainEntryCharStyle()

const OUString & SwTOXBase::GetMainEntryCharStyle ( ) const
inline

◆ GetMSTOCExpression()

const OUString & SwTOXBase::GetMSTOCExpression ( ) const
inline

Definition at line 485 of file tox.hxx.

◆ GetOLEOptions()

SwTOOElements SwTOXBase::GetOLEOptions ( ) const
inline

◆ GetOptions()

SwTOIOptions SwTOXBase::GetOptions ( ) const
inline

◆ GetSequenceName()

const OUString & SwTOXBase::GetSequenceName ( ) const
inline

◆ GetSortAlgorithm()

const OUString & SwTOXBase::GetSortAlgorithm ( ) const
inline

◆ GetStyleNames()

OUString const & SwTOXBase::GetStyleNames ( sal_uInt16  nLevel) const
inline

◆ GetTitle()

const OUString & SwTOXBase::GetTitle ( ) const
inline

◆ GetTOXForm()

const SwForm & SwTOXBase::GetTOXForm ( ) const
inline

◆ GetTOXName()

const OUString & SwTOXBase::GetTOXName ( ) const
inline

◆ GetTOXType()

const SwTOXType * SwTOXBase::GetTOXType ( ) const
inline

◆ GetType()

TOXTypes SwTOXBase::GetType ( ) const
inline

◆ GetTypeName()

OUString const & SwTOXBase::GetTypeName ( ) const
inline

Definition at line 710 of file tox.hxx.

References GetTOXType(), and SwTOXType::GetTypeName().

◆ IsFromChapter()

bool SwTOXBase::IsFromChapter ( ) const
inline

◆ IsFromObjectNames()

bool SwTOXBase::IsFromObjectNames ( ) const
inline

◆ IsLevelFromChapter()

bool SwTOXBase::IsLevelFromChapter ( ) const
inline

◆ IsProtected()

bool SwTOXBase::IsProtected ( ) const
inline

◆ IsTOXBaseInReadonly()

bool SwTOXBase::IsTOXBaseInReadonly ( ) const

◆ IsVisible()

virtual bool SwTOXBase::IsVisible ( ) const
inlinevirtual

Reimplemented in SwTOXBaseSection.

Definition at line 565 of file tox.hxx.

Referenced by SwContentType::FillMemberList().

◆ operator=()

SwTOXBase & SwTOXBase::operator= ( const SwTOXBase rSource)

◆ RegisterToTOXType()

void SwTOXBase::RegisterToTOXType ( SwTOXType rMark)

Definition at line 561 of file tox.cxx.

References SwModify::Add().

Referenced by lcl_ReAssignTOXType(), and lcl_toxMatchACSwitch().

◆ SetAttrSet()

void SwTOXBase::SetAttrSet ( const SfxItemSet rSet)

Definition at line 2125 of file doctxm.cxx.

References SwSection::GetFormat(), rSet, and SwFormat::SetFormatAttr().

Referenced by operator=().

◆ SetBookmarkName()

void SwTOXBase::SetBookmarkName ( const OUString &  bName)

Definition at line 632 of file tox.cxx.

References m_aBookmarkName.

Referenced by SwXDocumentIndex::setPropertyValue().

◆ SetCaptionDisplay()

void SwTOXBase::SetCaptionDisplay ( SwCaptionDisplay  eSet)
inline

◆ SetCreate()

void SwTOXBase::SetCreate ( SwTOXElement  nCreate)
inline

◆ SetFromChapter()

void SwTOXBase::SetFromChapter ( bool  bSet)
inline

◆ SetFromObjectNames()

void SwTOXBase::SetFromObjectNames ( bool  bSet)
inline

◆ SetLanguage()

void SwTOXBase::SetLanguage ( LanguageType  nLang)
inline

◆ SetLevel()

void SwTOXBase::SetLevel ( sal_uInt16  nLev)
inline

◆ SetLevelFromChapter()

void SwTOXBase::SetLevelFromChapter ( bool  bSet)
inline

◆ SetMainEntryCharStyle()

void SwTOXBase::SetMainEntryCharStyle ( const OUString &  rSet)
inline

Definition at line 503 of file tox.hxx.

References rSet.

Referenced by SwXDocumentIndex::setPropertyValue(), and SwTOXMgr::UpdateOrInsertTOX().

◆ SetMSTOCExpression()

void SwTOXBase::SetMSTOCExpression ( const OUString &  rExp)
inline

Definition at line 486 of file tox.hxx.

◆ SetOLEOptions()

void SwTOXBase::SetOLEOptions ( SwTOOElements  nOpt)
inline

◆ SetOptions()

void SwTOXBase::SetOptions ( SwTOIOptions  nOpt)
inline

◆ SetProtected()

void SwTOXBase::SetProtected ( bool  bSet)
inline

◆ SetSequenceName()

void SwTOXBase::SetSequenceName ( const OUString &  rSet)
inline

◆ SetSortAlgorithm()

void SwTOXBase::SetSortAlgorithm ( const OUString &  rSet)
inline

◆ SetStyleNames()

void SwTOXBase::SetStyleNames ( const OUString &  rSet,
sal_uInt16  nLevel 
)
inline

◆ SetTitle()

void SwTOXBase::SetTitle ( const OUString &  rTitle)

◆ SetTOXForm()

void SwTOXBase::SetTOXForm ( const SwForm rForm)
inline

◆ SetTOXName()

void SwTOXBase::SetTOXName ( const OUString &  rSet)
inline

Definition at line 482 of file tox.hxx.

References m_aName, and rSet.

Referenced by SwDoc::InsertTableOf(), SwXDocumentIndex::setPropertyValue(), and SwDoc::SetTOXBaseName().

◆ SwClientNotify()

virtual void SwTOXBase::SwClientNotify ( const SwModify rMod,
const SfxHint rHint 
)
inlineoverridevirtual

Reimplemented from SwClient.

Reimplemented in SwTOXBaseSection.

Definition at line 466 of file tox.hxx.

References SwClient::GetRegisteredIn(), SwModify::Remove(), and SwClient::SwClientNotify().

Referenced by SwTOXBaseSection::SwClientNotify().

Member Data Documentation

◆ m_aBookmarkName

OUString SwTOXBase::m_aBookmarkName
private

Definition at line 430 of file tox.hxx.

Referenced by CopyTOXBase(), GetBookmarkName(), operator=(), and SetBookmarkName().

◆ 

union { ... } SwTOXBase::m_aData

◆ m_aForm

SwForm SwTOXBase::m_aForm
private

Definition at line 427 of file tox.hxx.

Referenced by CopyTOXBase(), GetTOXForm(), operator=(), and SetTOXForm().

◆ m_aName

OUString SwTOXBase::m_aName
private

Definition at line 428 of file tox.hxx.

Referenced by CopyTOXBase(), and operator=().

◆ m_aStyleNames

OUString SwTOXBase::m_aStyleNames[MAXLEVEL]
private

Definition at line 434 of file tox.hxx.

Referenced by CopyTOXBase(), and operator=().

◆ m_aTitle

OUString SwTOXBase::m_aTitle
private

Definition at line 429 of file tox.hxx.

Referenced by CopyTOXBase(), GetTitle(), operator=(), and SetTitle().

◆ m_bFromChapter

bool SwTOXBase::m_bFromChapter
private

Definition at line 449 of file tox.hxx.

Referenced by CopyTOXBase(), and operator=().

◆ m_bFromObjectNames

bool SwTOXBase::m_bFromObjectNames
private

Definition at line 450 of file tox.hxx.

Referenced by CopyTOXBase(), and operator=().

◆ m_bLevelFromChapter

bool SwTOXBase::m_bLevelFromChapter
private

Definition at line 452 of file tox.hxx.

Referenced by CopyTOXBase(), and operator=().

◆ m_bProtected

bool SwTOXBase::m_bProtected
private

Definition at line 448 of file tox.hxx.

Referenced by CopyTOXBase(), and operator=().

◆ m_eCaptionDisplay

SwCaptionDisplay SwTOXBase::m_eCaptionDisplay
private

Definition at line 447 of file tox.hxx.

Referenced by CopyTOXBase(), and operator=().

◆ m_eLanguage

LanguageType SwTOXBase::m_eLanguage
private

Definition at line 437 of file tox.hxx.

Referenced by CopyTOXBase(), and operator=().

◆ m_nCreateType

SwTOXElement SwTOXBase::m_nCreateType
private

Definition at line 445 of file tox.hxx.

Referenced by CopyTOXBase(), GetCreateType(), operator=(), and SetCreate().

◆ m_nOLEOptions

SwTOOElements SwTOXBase::m_nOLEOptions
private

Definition at line 446 of file tox.hxx.

Referenced by CopyTOXBase(), and operator=().

◆ m_sMainEntryCharStyle

OUString SwTOXBase::m_sMainEntryCharStyle
private

Definition at line 432 of file tox.hxx.

Referenced by CopyTOXBase(), and operator=().

◆ m_sSequenceName

OUString SwTOXBase::m_sSequenceName
private

Definition at line 435 of file tox.hxx.

Referenced by CopyTOXBase(), and operator=().

◆ m_sSortAlgorithm

OUString SwTOXBase::m_sSortAlgorithm
private

Definition at line 438 of file tox.hxx.

Referenced by CopyTOXBase(), and operator=().

◆ maMSTOCExpression

OUString SwTOXBase::maMSTOCExpression
protected

Definition at line 457 of file tox.hxx.

Referenced by CopyTOXBase(), and SwTOXBaseSection::Update().

◆ mbKeepExpression

bool SwTOXBase::mbKeepExpression
protected

Definition at line 458 of file tox.hxx.

Referenced by SwTOXBaseSection::Update().

◆ nLevel

sal_uInt16 SwTOXBase::nLevel

◆ nOptions

SwTOIOptions SwTOXBase::nOptions

Definition at line 442 of file tox.hxx.

Referenced by CopyTOXBase().


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