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

#include <toxmgr.hxx>

Collaboration diagram for SwTOXDescription:
[legend]

Public Member Functions

 SwTOXDescription (TOXTypes eType)
 
TOXTypes GetTOXType () const
 
const OUString & GetStyleNames (sal_uInt16 nLvl) const
 
void SetStyleNames (const OUString &rSet, sal_uInt16 nLvl)
 
const OUString & GetAutoMarkURL () const
 
void SetAutoMarkURL (const OUString &rSet)
 
void SetTitle (const OUString &rSet)
 
std::optional< OUString > const & GetTitle () const
 
void SetTOUName (const OUString &rSet)
 
std::optional< OUString > const & GetTOUName () const
 
void SetForm (const SwForm &rSet)
 
const SwForm * GetForm () const
 
void SetContentOptions (SwTOXElement nSet)
 
SwTOXElement GetContentOptions () const
 
void SetIndexOptions (SwTOIOptions nSet)
 
SwTOIOptions GetIndexOptions () const
 
const OUString & GetMainEntryCharStyle () const
 
void SetMainEntryCharStyle (const OUString &rSet)
 
void SetLevel (sal_uInt8 nSet)
 
sal_uInt8 GetLevel () const
 
void SetCreateFromObjectNames (bool bSet)
 
bool IsCreateFromObjectNames () const
 
const OUString & GetSequenceName () const
 
void SetSequenceName (const OUString &rSet)
 
SwCaptionDisplay GetCaptionDisplay () const
 
void SetCaptionDisplay (SwCaptionDisplay eSet)
 
void SetFromChapter (bool bSet)
 
bool IsFromChapter () const
 
void SetReadonly (bool bSet)
 
bool IsReadonly () const
 
SwTOOElements GetOLEOptions () const
 
void SetOLEOptions (SwTOOElements nOpt)
 
bool IsLevelFromChapter () const
 
void SetLevelFromChapter (bool bSet)
 
const OUString & GetAuthBrackets () const
 
void SetAuthBrackets (const OUString &rSet)
 
bool IsAuthSequence () const
 
void SetAuthSequence (bool bSet)
 
bool IsSortByDocument () const
 
void SetSortByDocument (bool bSet)
 
void SetSortKeys (SwTOXSortKey eKey1, SwTOXSortKey eKey2, SwTOXSortKey eKey3)
 
const SwTOXSortKey & GetSortKey1 () const
 
const SwTOXSortKey & GetSortKey2 () const
 
const SwTOXSortKey & GetSortKey3 () const
 
LanguageType GetLanguage () const
 
void SetLanguage (LanguageType nLang)
 
const OUString & GetSortAlgorithm () const
 
void SetSortAlgorithm (const OUString &rSet)
 
void ApplyTo (SwTOXBase &rTOXBase)
 

Private Member Functions

 SwTOXDescription (SwTOXDescription const &)=delete
 
SwTOXDescription & operator= (SwTOXDescription const &)=delete
 

Private Attributes

TOXTypes m_eTOXType
 
OUString m_aStyleNames [MAXLEVEL]
 
OUString m_sSequenceName
 
OUString m_sMainEntryCharStyle
 
OUString m_sAutoMarkURL
 
std::optional< OUString > m_aTitle
 
std::optional< OUString > m_aTOUName
 
std::unique_ptr< SwForm > m_pForm
 
SwTOXElement m_nContent
 
SwTOIOptions m_nIndexOptions
 
SwTOOElements m_nOLEOptions
 
LanguageType m_eLanguage
 
OUString m_sSortAlgorithm
 
OUString m_sAuthBrackets
 
SwCaptionDisplay m_eCaptionDisplay
 
SwTOXSortKey m_eSortKey1
 
SwTOXSortKey m_eSortKey2
 
SwTOXSortKey m_eSortKey3
 
sal_uInt8 m_nLevel
 
bool m_bFromObjectNames: 1
 
bool m_bFromChapter: 1
 
bool m_bReadonly: 1
 
bool m_bLevelFromChapter: 1
 
bool m_bIsAuthSequence:1
 
bool m_bSortByDocument:1
 

Detailed Description

Definition at line 34 of file toxmgr.hxx.

Constructor & Destructor Documentation

◆ SwTOXDescription() [1/2]

SwTOXDescription::SwTOXDescription ( SwTOXDescription const &  )
privatedelete

◆ SwTOXDescription() [2/2]

SwTOXDescription::SwTOXDescription ( TOXTypes  eType)
inlineexplicit

Definition at line 74 of file toxmgr.hxx.

References eType, m_nLevel, and NONE.

Member Function Documentation

◆ ApplyTo()

void SwTOXDescription::ApplyTo ( SwTOXBase &  rTOXBase)

Definition at line 472 of file toxmgr.cxx.

References GetCaptionDisplay(), GetContentOptions(), GetIndexOptions(), GetLevel(), GetOLEOptions(), GetSequenceName(), GetStyleNames(), GetTitle(), GetTOXType(), i, IsCreateFromObjectNames(), IsFromChapter(), IsLevelFromChapter(), IsReadonly(), m_eLanguage, m_sSortAlgorithm, MAXLEVEL, SwTOXBase::SetCaptionDisplay(), SwTOXBase::SetCreate(), SwTOXBase::SetFromChapter(), SwTOXBase::SetFromObjectNames(), SwTOXBase::SetLanguage(), SwTOXBase::SetLevel(), SwTOXBase::SetLevelFromChapter(), SwTOXBase::SetOLEOptions(), SwTOXBase::SetOptions(), SwTOXBase::SetProtected(), SwTOXBase::SetSequenceName(), SwTOXBase::SetSortAlgorithm(), SwTOXBase::SetStyleNames(), SwTOXBase::SetTitle(), and TOX_INDEX.

Referenced by SwMultiTOXTabDialog::Ok().

◆ GetAuthBrackets()

const OUString & SwTOXDescription::GetAuthBrackets ( ) const
inline

Definition at line 142 of file toxmgr.hxx.

Referenced by SwTOXSelectTabPage::ApplyTOXDescription(), and SwTOXMgr::UpdateOrInsertTOX().

◆ GetAutoMarkURL()

const OUString & SwTOXDescription::GetAutoMarkURL ( ) const
inline

Definition at line 97 of file toxmgr.hxx.

Referenced by SwTOXMgr::UpdateOrInsertTOX().

◆ GetCaptionDisplay()

SwCaptionDisplay SwTOXDescription::GetCaptionDisplay ( ) const
inline

Definition at line 127 of file toxmgr.hxx.

Referenced by ApplyTo(), SwTOXSelectTabPage::ApplyTOXDescription(), SwMultiTOXTabDialog::CreateOrUpdateExample(), and SwTOXMgr::UpdateOrInsertTOX().

◆ GetContentOptions()

SwTOXElement SwTOXDescription::GetContentOptions ( ) const
inline

Definition at line 110 of file toxmgr.hxx.

Referenced by ApplyTo(), SwTOXSelectTabPage::ApplyTOXDescription(), SwMultiTOXTabDialog::CreateOrUpdateExample(), and SwTOXMgr::UpdateOrInsertTOX().

◆ GetForm()

const SwForm * SwTOXDescription::GetForm ( ) const
inline

Definition at line 107 of file toxmgr.hxx.

Referenced by SwTOXMgr::UpdateOrInsertTOX().

◆ GetIndexOptions()

SwTOIOptions SwTOXDescription::GetIndexOptions ( ) const
inline

Definition at line 113 of file toxmgr.hxx.

Referenced by ApplyTo(), SwTOXSelectTabPage::ApplyTOXDescription(), SwMultiTOXTabDialog::CreateOrUpdateExample(), SwTOXSelectTabPage::FillTOXDescription(), SwTOXEntryTabPage::Reset(), SwTOXEntryTabPage::UpdateDescriptor(), and SwTOXMgr::UpdateOrInsertTOX().

◆ GetLanguage()

LanguageType SwTOXDescription::GetLanguage ( ) const
inline

Definition at line 159 of file toxmgr.hxx.

Referenced by SwTOXSelectTabPage::ApplyTOXDescription(), and SwTOXMgr::UpdateOrInsertTOX().

◆ GetLevel()

sal_uInt8 SwTOXDescription::GetLevel ( ) const
inline

Definition at line 119 of file toxmgr.hxx.

References m_nLevel.

Referenced by ApplyTo(), SwTOXSelectTabPage::ApplyTOXDescription(), SwMultiTOXTabDialog::CreateOrUpdateExample(), and SwTOXMgr::UpdateOrInsertTOX().

◆ GetMainEntryCharStyle()

const OUString & SwTOXDescription::GetMainEntryCharStyle ( ) const
inline

Definition at line 115 of file toxmgr.hxx.

Referenced by SwTOXEntryTabPage::Reset(), and SwTOXMgr::UpdateOrInsertTOX().

◆ GetOLEOptions()

SwTOOElements SwTOXDescription::GetOLEOptions ( ) const
inline

Definition at line 136 of file toxmgr.hxx.

Referenced by ApplyTo(), SwTOXSelectTabPage::ApplyTOXDescription(), SwMultiTOXTabDialog::CreateOrUpdateExample(), and SwTOXMgr::UpdateOrInsertTOX().

◆ GetSequenceName()

const OUString & SwTOXDescription::GetSequenceName ( ) const
inline

Definition at line 124 of file toxmgr.hxx.

Referenced by ApplyTo(), SwTOXSelectTabPage::ApplyTOXDescription(), SwMultiTOXTabDialog::CreateOrUpdateExample(), and SwTOXMgr::UpdateOrInsertTOX().

◆ GetSortAlgorithm()

const OUString & SwTOXDescription::GetSortAlgorithm ( ) const
inline

Definition at line 162 of file toxmgr.hxx.

Referenced by SwTOXSelectTabPage::ApplyTOXDescription(), and SwTOXMgr::UpdateOrInsertTOX().

◆ GetSortKey1()

const SwTOXSortKey & SwTOXDescription::GetSortKey1 ( ) const
inline

Definition at line 155 of file toxmgr.hxx.

Referenced by SwTOXMgr::UpdateOrInsertTOX().

◆ GetSortKey2()

const SwTOXSortKey & SwTOXDescription::GetSortKey2 ( ) const
inline

Definition at line 156 of file toxmgr.hxx.

Referenced by SwTOXMgr::UpdateOrInsertTOX().

◆ GetSortKey3()

const SwTOXSortKey & SwTOXDescription::GetSortKey3 ( ) const
inline

Definition at line 157 of file toxmgr.hxx.

Referenced by SwTOXMgr::UpdateOrInsertTOX().

◆ GetStyleNames()

const OUString & SwTOXDescription::GetStyleNames ( sal_uInt16  nLvl) const
inline

Definition at line 92 of file toxmgr.hxx.

Referenced by ApplyTo(), SwTOXSelectTabPage::ApplyTOXDescription(), SwMultiTOXTabDialog::CreateOrUpdateExample(), and SwTOXMgr::UpdateOrInsertTOX().

◆ GetTitle()

std::optional< OUString > const & SwTOXDescription::GetTitle ( ) const
inline

Definition at line 101 of file toxmgr.hxx.

Referenced by ApplyTo(), SwTOXSelectTabPage::ApplyTOXDescription(), SwMultiTOXTabDialog::CreateOrUpdateExample(), and SwTOXMgr::UpdateOrInsertTOX().

◆ GetTOUName()

std::optional< OUString > const & SwTOXDescription::GetTOUName ( ) const
inline

Definition at line 104 of file toxmgr.hxx.

Referenced by SwTOXMgr::UpdateOrInsertTOX().

◆ GetTOXType()

TOXTypes SwTOXDescription::GetTOXType ( ) const
inline

Definition at line 90 of file toxmgr.hxx.

Referenced by ApplyTo(), SwTOXSelectTabPage::FillTOXDescription(), and SwTOXMgr::UpdateOrInsertTOX().

◆ IsAuthSequence()

bool SwTOXDescription::IsAuthSequence ( ) const
inline

Definition at line 145 of file toxmgr.hxx.

Referenced by SwTOXSelectTabPage::ApplyTOXDescription(), and SwTOXMgr::UpdateOrInsertTOX().

◆ IsCreateFromObjectNames()

bool SwTOXDescription::IsCreateFromObjectNames ( ) const
inline

Definition at line 122 of file toxmgr.hxx.

Referenced by ApplyTo(), SwTOXSelectTabPage::ApplyTOXDescription(), SwMultiTOXTabDialog::CreateOrUpdateExample(), and SwTOXMgr::UpdateOrInsertTOX().

◆ IsFromChapter()

bool SwTOXDescription::IsFromChapter ( ) const
inline

Definition at line 131 of file toxmgr.hxx.

Referenced by ApplyTo(), SwTOXSelectTabPage::ApplyTOXDescription(), SwMultiTOXTabDialog::CreateOrUpdateExample(), and SwTOXMgr::UpdateOrInsertTOX().

◆ IsLevelFromChapter()

bool SwTOXDescription::IsLevelFromChapter ( ) const
inline

Definition at line 139 of file toxmgr.hxx.

Referenced by ApplyTo(), SwTOXSelectTabPage::ApplyTOXDescription(), and SwTOXMgr::UpdateOrInsertTOX().

◆ IsReadonly()

bool SwTOXDescription::IsReadonly ( ) const
inline

Definition at line 134 of file toxmgr.hxx.

Referenced by ApplyTo(), SwTOXSelectTabPage::ApplyTOXDescription(), SwMultiTOXTabDialog::CreateOrUpdateExample(), and SwTOXMgr::UpdateOrInsertTOX().

◆ IsSortByDocument()

bool SwTOXDescription::IsSortByDocument ( ) const
inline

Definition at line 148 of file toxmgr.hxx.

Referenced by SwTOXMgr::UpdateOrInsertTOX().

◆ operator=()

SwTOXDescription & SwTOXDescription::operator= ( SwTOXDescription const &  )
privatedelete

◆ SetAuthBrackets()

void SwTOXDescription::SetAuthBrackets ( const OUString &  rSet)
inline

Definition at line 143 of file toxmgr.hxx.

References rSet.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetAuthSequence()

void SwTOXDescription::SetAuthSequence ( bool  bSet)
inline

Definition at line 146 of file toxmgr.hxx.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetAutoMarkURL()

void SwTOXDescription::SetAutoMarkURL ( const OUString &  rSet)
inline

Definition at line 98 of file toxmgr.hxx.

References rSet.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetCaptionDisplay()

void SwTOXDescription::SetCaptionDisplay ( SwCaptionDisplay  eSet)
inline

Definition at line 128 of file toxmgr.hxx.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetContentOptions()

void SwTOXDescription::SetContentOptions ( SwTOXElement  nSet)
inline

Definition at line 109 of file toxmgr.hxx.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetCreateFromObjectNames()

void SwTOXDescription::SetCreateFromObjectNames ( bool  bSet)
inline

Definition at line 121 of file toxmgr.hxx.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetForm()

void SwTOXDescription::SetForm ( const SwForm &  rSet)
inline

Definition at line 106 of file toxmgr.hxx.

References rSet.

Referenced by SwMultiTOXTabDialog::Ok().

◆ SetFromChapter()

void SwTOXDescription::SetFromChapter ( bool  bSet)
inline

Definition at line 130 of file toxmgr.hxx.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetIndexOptions()

void SwTOXDescription::SetIndexOptions ( SwTOIOptions  nSet)
inline

Definition at line 112 of file toxmgr.hxx.

Referenced by SwTOXSelectTabPage::FillTOXDescription(), and SwTOXEntryTabPage::UpdateDescriptor().

◆ SetLanguage()

void SwTOXDescription::SetLanguage ( LanguageType  nLang)
inline

Definition at line 160 of file toxmgr.hxx.

References nLang.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetLevel()

void SwTOXDescription::SetLevel ( sal_uInt8  nSet)
inline

Definition at line 118 of file toxmgr.hxx.

References m_nLevel.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetLevelFromChapter()

void SwTOXDescription::SetLevelFromChapter ( bool  bSet)
inline

Definition at line 140 of file toxmgr.hxx.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetMainEntryCharStyle()

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

Definition at line 116 of file toxmgr.hxx.

References rSet.

Referenced by SwTOXEntryTabPage::UpdateDescriptor().

◆ SetOLEOptions()

void SwTOXDescription::SetOLEOptions ( SwTOOElements  nOpt)
inline

Definition at line 137 of file toxmgr.hxx.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetReadonly()

void SwTOXDescription::SetReadonly ( bool  bSet)
inline

Definition at line 133 of file toxmgr.hxx.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetSequenceName()

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

Definition at line 125 of file toxmgr.hxx.

References rSet.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetSortAlgorithm()

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

Definition at line 163 of file toxmgr.hxx.

References rSet.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetSortByDocument()

void SwTOXDescription::SetSortByDocument ( bool  bSet)
inline

Definition at line 149 of file toxmgr.hxx.

Referenced by SwTOXEntryTabPage::UpdateDescriptor().

◆ SetSortKeys()

void SwTOXDescription::SetSortKeys ( SwTOXSortKey  eKey1,
SwTOXSortKey  eKey2,
SwTOXSortKey  eKey3 
)

Definition at line 454 of file toxmgr.cxx.

References sw::sidebar::aArr, AUTH_FIELD_END, SwTOXSortKey::eField, m_eSortKey1, m_eSortKey2, m_eSortKey3, and nPos.

Referenced by SwTOXEntryTabPage::UpdateDescriptor().

◆ SetStyleNames()

void SwTOXDescription::SetStyleNames ( const OUString &  rSet,
sal_uInt16  nLvl 
)
inline

Definition at line 94 of file toxmgr.hxx.

References rSet.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetTitle()

void SwTOXDescription::SetTitle ( const OUString &  rSet)
inline

Definition at line 100 of file toxmgr.hxx.

References rSet.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

◆ SetTOUName()

void SwTOXDescription::SetTOUName ( const OUString &  rSet)
inline

Definition at line 103 of file toxmgr.hxx.

References rSet.

Referenced by SwTOXSelectTabPage::FillTOXDescription().

Member Data Documentation

◆ m_aStyleNames

OUString SwTOXDescription::m_aStyleNames[MAXLEVEL]
private

Definition at line 37 of file toxmgr.hxx.

◆ m_aTitle

std::optional<OUString> SwTOXDescription::m_aTitle
private

Definition at line 42 of file toxmgr.hxx.

◆ m_aTOUName

std::optional<OUString> SwTOXDescription::m_aTOUName
private

Definition at line 44 of file toxmgr.hxx.

◆ m_bFromChapter

bool SwTOXDescription::m_bFromChapter
private

Definition at line 60 of file toxmgr.hxx.

◆ m_bFromObjectNames

bool SwTOXDescription::m_bFromObjectNames
private

Definition at line 59 of file toxmgr.hxx.

◆ m_bIsAuthSequence

bool SwTOXDescription::m_bIsAuthSequence
private

Definition at line 63 of file toxmgr.hxx.

◆ m_bLevelFromChapter

bool SwTOXDescription::m_bLevelFromChapter
private

Definition at line 62 of file toxmgr.hxx.

◆ m_bReadonly

bool SwTOXDescription::m_bReadonly
private

Definition at line 61 of file toxmgr.hxx.

◆ m_bSortByDocument

bool SwTOXDescription::m_bSortByDocument
private

Definition at line 64 of file toxmgr.hxx.

◆ m_eCaptionDisplay

SwCaptionDisplay SwTOXDescription::m_eCaptionDisplay
private

Definition at line 54 of file toxmgr.hxx.

◆ m_eLanguage

LanguageType SwTOXDescription::m_eLanguage
private

Definition at line 50 of file toxmgr.hxx.

Referenced by ApplyTo().

◆ m_eSortKey1

SwTOXSortKey SwTOXDescription::m_eSortKey1
private

Definition at line 55 of file toxmgr.hxx.

Referenced by SetSortKeys().

◆ m_eSortKey2

SwTOXSortKey SwTOXDescription::m_eSortKey2
private

Definition at line 56 of file toxmgr.hxx.

Referenced by SetSortKeys().

◆ m_eSortKey3

SwTOXSortKey SwTOXDescription::m_eSortKey3
private

Definition at line 57 of file toxmgr.hxx.

Referenced by SetSortKeys().

◆ m_eTOXType

TOXTypes SwTOXDescription::m_eTOXType
private

Definition at line 36 of file toxmgr.hxx.

◆ m_nContent

SwTOXElement SwTOXDescription::m_nContent
private

Definition at line 47 of file toxmgr.hxx.

◆ m_nIndexOptions

SwTOIOptions SwTOXDescription::m_nIndexOptions
private

Definition at line 48 of file toxmgr.hxx.

◆ m_nLevel

sal_uInt8 SwTOXDescription::m_nLevel
private

Definition at line 58 of file toxmgr.hxx.

◆ m_nOLEOptions

SwTOOElements SwTOXDescription::m_nOLEOptions
private

Definition at line 49 of file toxmgr.hxx.

◆ m_pForm

std::unique_ptr<SwForm> SwTOXDescription::m_pForm
private

Definition at line 46 of file toxmgr.hxx.

◆ m_sAuthBrackets

OUString SwTOXDescription::m_sAuthBrackets
private

Definition at line 53 of file toxmgr.hxx.

◆ m_sAutoMarkURL

OUString SwTOXDescription::m_sAutoMarkURL
private

Definition at line 40 of file toxmgr.hxx.

◆ m_sMainEntryCharStyle

OUString SwTOXDescription::m_sMainEntryCharStyle
private

Definition at line 39 of file toxmgr.hxx.

◆ m_sSequenceName

OUString SwTOXDescription::m_sSequenceName
private

Definition at line 38 of file toxmgr.hxx.

◆ m_sSortAlgorithm

OUString SwTOXDescription::m_sSortAlgorithm
private

Definition at line 51 of file toxmgr.hxx.

Referenced by ApplyTo().

The documentation for this class was generated from the following files:
Generated on Thu Feb 2 2023 22:14:50 for LibreOffice Module sw (master) by doxygen 1.9.3