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

#include <tox.hxx>

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

Public Member Functions

 SwTOXMark (const SwTOXType *pTyp)
 
virtual ~SwTOXMark () override
 
 SwTOXMark (const SwTOXMark &rCopy)
 
SwTOXMarkoperator= (const SwTOXMark &rCopy)
 
virtual bool operator== (const SfxPoolItem &) const override
 
virtual SwTOXMarkClone (SfxItemPool *pPool=nullptr) const override
 
void InvalidateTOXMark ()
 
OUString GetText (SwRootFrame const *pLayout) const
 
bool IsAlternativeText () const
 
const OUString & GetAlternativeText () const
 
void SetAlternativeText (const OUString &rAlt)
 
void SetLevel (sal_uInt16 nLevel)
 
sal_uInt16 GetLevel () const
 
void SetBookmarkName (const OUString &bName)
 
const OUString & GetBookmarkName () const
 
void SetPrimaryKey (const OUString &rStr)
 
void SetSecondaryKey (const OUString &rStr)
 
void SetTextReading (const OUString &rStr)
 
void SetPrimaryKeyReading (const OUString &rStr)
 
void SetSecondaryKeyReading (const OUString &rStr)
 
OUString const & GetPrimaryKey () const
 
OUString const & GetSecondaryKey () const
 
OUString const & GetTextReading () const
 
OUString const & GetPrimaryKeyReading () const
 
OUString const & GetSecondaryKeyReading () const
 
bool IsAutoGenerated () const
 
void SetAutoGenerated (bool bSet)
 
bool IsMainEntry () const
 
void SetMainEntry (bool bSet)
 
const SwTOXTypeGetTOXType () const
 
const SwTextTOXMarkGetTextTOXMark () const
 
SwTextTOXMarkGetTextTOXMark ()
 
SAL_DLLPRIVATE unotools::WeakReference< SwXDocumentIndexMark > const & GetXTOXMark () const
 
SAL_DLLPRIVATE void SetXTOXMark (rtl::Reference< SwXDocumentIndexMark > const &xMark)
 
void RegisterToTOXType (SwTOXType &rMark)
 
- Public Member Functions inherited from SfxPoolItem
void AddRef (sal_uInt32 n=1) const
 
virtual ~SfxPoolItem ()
 
void SetWhich (sal_uInt16 nId)
 
sal_uInt16 Which () const
 
T & StaticWhichCast (TypedWhichId< T > nId)
 
const T & StaticWhichCast (TypedWhichId< T > nId) const
 
T * DynamicWhichCast (TypedWhichId< T > nId)
 
const T * DynamicWhichCast (TypedWhichId< T > nId) const
 
virtual bool operator== (const SfxPoolItem &) const=0
 
bool operator!= (const SfxPoolItem &rItem) const
 
virtual bool operator< (const SfxPoolItem &) const
 
virtual bool IsSortable () const
 
virtual bool HasLookup () const
 
virtual lookup_iterator Lookup (lookup_iterator, lookup_iterator end) const
 
virtual bool GetPresentation (SfxItemPresentation ePresentation, MapUnit eCoreMetric, MapUnit ePresentationMetric, OUString &rText, const IntlWrapper &rIntlWrapper) const
 
virtual void ScaleMetrics (tools::Long lMult, tools::Long lDiv)
 
virtual bool HasMetrics () const
 
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt8 nMemberId=0) const
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt8 nMemberId)
 
virtual SfxPoolItemClone (SfxItemPool *pPool=nullptr) const=0
 
std::unique_ptr< SfxPoolItemCloneSetWhich (sal_uInt16 nNewWhich) const
 
std::unique_ptr< T > CloneSetWhich (TypedWhichId< T > nId) const
 
sal_uInt32 GetRefCount () const
 
SfxItemKind GetKind () const
 
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const
 
virtual boost::property_tree::ptree dumpAsJSON () const
 
virtual bool IsVoidItem () 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
 

Static Public Attributes

static constexpr OUStringLiteral S_PAGE_DELI = u", "
 

Private Member Functions

 SwTOXMark ()
 pool default constructor More...
 
virtual void Notify (const SfxHint &rHint) override
 

Private Attributes

const SwTOXTypem_pType
 
OUString m_aAltText
 
OUString m_aPrimaryKey
 
OUString m_aSecondaryKey
 
OUString m_aTextReading
 
OUString m_aPrimaryKeyReading
 
OUString m_aSecondaryKeyReading
 
SwTextTOXMarkm_pTextAttr
 
sal_uInt16 m_nLevel
 
OUString m_aBookmarkName
 
bool m_bAutoGenerated
 
bool m_bMainEntry
 
unotools::WeakReference< SwXDocumentIndexMarkm_wXDocumentIndexMark
 

Friends

class SwTextTOXMark
 
void InitCore ()
 

Additional Inherited Members

- Public Types inherited from SfxPoolItem
typedef std::vector< SfxPoolItem * >::const_iterator lookup_iterator
 
- Protected Member Functions inherited from SfxPoolItem
 SfxPoolItem (sal_uInt16 nWhich=0)
 
 SfxPoolItem (const SfxPoolItem &rCopy)
 

Detailed Description

Definition at line 80 of file tox.hxx.

Constructor & Destructor Documentation

◆ SwTOXMark() [1/3]

SwTOXMark::SwTOXMark ( )
private

pool default constructor

Definition at line 93 of file tox.cxx.

References m_nLevel.

Referenced by Clone().

◆ SwTOXMark() [2/3]

SwTOXMark::SwTOXMark ( const SwTOXType pTyp)
explicit

Definition at line 103 of file tox.cxx.

References m_nLevel, m_pType, and SvtListener::StartListening().

◆ ~SwTOXMark()

SwTOXMark::~SwTOXMark ( )
overridevirtual

Definition at line 134 of file tox.cxx.

◆ SwTOXMark() [3/3]

SwTOXMark::SwTOXMark ( const SwTOXMark rCopy)

Definition at line 114 of file tox.cxx.

References m_aAltText, m_nLevel, m_pType, and SvtListener::StartListening().

Member Function Documentation

◆ Clone()

SwTOXMark * SwTOXMark::Clone ( SfxItemPool pPool = nullptr) const
overridevirtual

Implements SfxPoolItem.

Definition at line 154 of file tox.cxx.

References SwTOXMark().

◆ GetAlternativeText()

const OUString & SwTOXMark::GetAlternativeText ( ) const
inline

◆ GetBookmarkName()

const OUString & SwTOXMark::GetBookmarkName ( ) const
inline

Definition at line 573 of file tox.hxx.

References m_aBookmarkName.

◆ GetLevel()

sal_uInt16 SwTOXMark::GetLevel ( ) const
inline

◆ GetPrimaryKey()

OUString const & SwTOXMark::GetPrimaryKey ( ) const
inline

◆ GetPrimaryKeyReading()

OUString const & SwTOXMark::GetPrimaryKeyReading ( ) const
inline

◆ GetSecondaryKey()

OUString const & SwTOXMark::GetSecondaryKey ( ) const
inline

◆ GetSecondaryKeyReading()

OUString const & SwTOXMark::GetSecondaryKeyReading ( ) const
inline

◆ GetText()

OUString SwTOXMark::GetText ( SwRootFrame const *  pLayout) const

◆ GetTextReading()

OUString const & SwTOXMark::GetTextReading ( ) const
inline

◆ GetTextTOXMark() [1/2]

SwTextTOXMark * SwTOXMark::GetTextTOXMark ( )
inline

Definition at line 161 of file tox.hxx.

◆ GetTextTOXMark() [2/2]

const SwTextTOXMark * SwTOXMark::GetTextTOXMark ( ) const
inline

◆ GetTOXType()

const SwTOXType * SwTOXMark::GetTOXType ( ) const
inline

◆ GetXTOXMark()

SAL_DLLPRIVATE unotools::WeakReference< SwXDocumentIndexMark > const & SwTOXMark::GetXTOXMark ( ) const
inline

Definition at line 163 of file tox.hxx.

Referenced by SwXDocumentIndexMark::CreateXDocumentIndexMark().

◆ InvalidateTOXMark()

void SwTOXMark::InvalidateTOXMark ( )

Definition at line 195 of file tox.cxx.

References RES_REMOVE_UNO_OBJECT().

◆ IsAlternativeText()

bool SwTOXMark::IsAlternativeText ( ) const
inline

◆ IsAutoGenerated()

bool SwTOXMark::IsAutoGenerated ( ) const
inline

Definition at line 152 of file tox.hxx.

◆ IsMainEntry()

bool SwTOXMark::IsMainEntry ( ) const
inline

Definition at line 155 of file tox.hxx.

Referenced by SwTOXSortTabBase::SwTOXSortTabBase(), and SwIndexMarkPane::UpdateDialog().

◆ Notify()

void SwTOXMark::Notify ( const SfxHint rHint)
overrideprivatevirtual

◆ operator=()

SwTOXMark & SwTOXMark::operator= ( const SwTOXMark rCopy)

◆ operator==()

bool SwTOXMark::operator== ( const SfxPoolItem rAttr) const
overridevirtual

Implements SfxPoolItem.

Definition at line 148 of file tox.cxx.

References m_pType.

◆ RegisterToTOXType()

void SwTOXMark::RegisterToTOXType ( SwTOXType rMark)

◆ SetAlternativeText()

void SwTOXMark::SetAlternativeText ( const OUString &  rAlt)
inline

◆ SetAutoGenerated()

void SwTOXMark::SetAutoGenerated ( bool  bSet)
inline

Definition at line 153 of file tox.hxx.

Referenced by SwEditShell::ApplyAutoMark().

◆ SetBookmarkName()

void SwTOXMark::SetBookmarkName ( const OUString &  bName)
inline

Definition at line 587 of file tox.hxx.

References m_aBookmarkName.

Referenced by SwXDocumentIndexMark::setPropertyValue().

◆ SetLevel()

void SwTOXMark::SetLevel ( sal_uInt16  nLevel)
inline

◆ SetMainEntry()

void SwTOXMark::SetMainEntry ( bool  bSet)
inline

◆ SetPrimaryKey()

void SwTOXMark::SetPrimaryKey ( const OUString &  rStr)
inline

◆ SetPrimaryKeyReading()

void SwTOXMark::SetPrimaryKeyReading ( const OUString &  rStr)
inline

◆ SetSecondaryKey()

void SwTOXMark::SetSecondaryKey ( const OUString &  rStr)
inline

◆ SetSecondaryKeyReading()

void SwTOXMark::SetSecondaryKeyReading ( const OUString &  rStr)
inline

◆ SetTextReading()

void SwTOXMark::SetTextReading ( const OUString &  rStr)
inline

◆ SetXTOXMark()

void SwTOXMark::SetXTOXMark ( rtl::Reference< SwXDocumentIndexMark > const &  xMark)

Definition at line 138 of file tox.cxx.

References m_wXDocumentIndexMark.

Referenced by SwXDocumentIndexMark::CreateXDocumentIndexMark(), and Notify().

Friends And Related Function Documentation

◆ InitCore

void InitCore ( )
friend

Definition at line 449 of file init.cxx.

◆ SwTextTOXMark

friend class SwTextTOXMark
friend

Definition at line 86 of file tox.hxx.

Member Data Documentation

◆ m_aAltText

OUString SwTOXMark::m_aAltText
private

Definition at line 89 of file tox.hxx.

Referenced by GetAlternativeText(), GetText(), IsAlternativeText(), SetAlternativeText(), and SwTOXMark().

◆ m_aBookmarkName

OUString SwTOXMark::m_aBookmarkName
private

Definition at line 101 of file tox.hxx.

Referenced by GetBookmarkName(), and SetBookmarkName().

◆ m_aPrimaryKey

OUString SwTOXMark::m_aPrimaryKey
private

Definition at line 90 of file tox.hxx.

Referenced by GetPrimaryKey(), and SetPrimaryKey().

◆ m_aPrimaryKeyReading

OUString SwTOXMark::m_aPrimaryKeyReading
private

Definition at line 95 of file tox.hxx.

Referenced by GetPrimaryKeyReading(), and SetPrimaryKeyReading().

◆ m_aSecondaryKey

OUString SwTOXMark::m_aSecondaryKey
private

Definition at line 91 of file tox.hxx.

Referenced by GetSecondaryKey(), and SetSecondaryKey().

◆ m_aSecondaryKeyReading

OUString SwTOXMark::m_aSecondaryKeyReading
private

Definition at line 96 of file tox.hxx.

Referenced by GetSecondaryKeyReading(), and SetSecondaryKeyReading().

◆ m_aTextReading

OUString SwTOXMark::m_aTextReading
private

Definition at line 94 of file tox.hxx.

Referenced by GetTextReading(), and SetTextReading().

◆ m_bAutoGenerated

bool SwTOXMark::m_bAutoGenerated
private

Definition at line 102 of file tox.hxx.

◆ m_bMainEntry

bool SwTOXMark::m_bMainEntry
private

Definition at line 103 of file tox.hxx.

◆ m_nLevel

sal_uInt16 SwTOXMark::m_nLevel
private

Definition at line 100 of file tox.hxx.

Referenced by GetLevel(), and SetLevel().

◆ m_pTextAttr

SwTextTOXMark* SwTOXMark::m_pTextAttr
private

Definition at line 98 of file tox.hxx.

Referenced by GetText(), and SwTextTOXMark::SwTextTOXMark().

◆ m_pType

const SwTOXType* SwTOXMark::m_pType
private

Definition at line 88 of file tox.hxx.

Referenced by GetTOXType(), operator==(), RegisterToTOXType(), and SwTOXMark().

◆ m_wXDocumentIndexMark

unotools::WeakReference<SwXDocumentIndexMark> SwTOXMark::m_wXDocumentIndexMark
private

Definition at line 105 of file tox.hxx.

Referenced by SetXTOXMark().

◆ S_PAGE_DELI

constexpr OUStringLiteral SwTOXMark::S_PAGE_DELI = u", "
staticconstexpr

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