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 SetEntryTypeName (const OUString &sName)
 
const OUString & GetEntryTypeName () 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 css::uno::WeakReference< css::text::XDocumentIndexMark > const & GetXTOXMark () const
 
SAL_DLLPRIVATE void SetXTOXMark (css::uno::Reference< css::text::XDocumentIndexMark > 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
 
bool operator!= (const SfxPoolItem &rItem) const
 
virtual bool operator< (const SfxPoolItem &) const
 
virtual bool IsSortable () 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)
 
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 sw::BroadcastingModify
virtual void CallSwClientNotify (const SfxHint &rHint) const override
 
- Public Member Functions inherited from SwModify
 SwModify ()
 
virtual ~SwModify () override
 
void Add (SwClient *pDepend)
 
SwClientRemove (SwClient *pDepend)
 
bool HasWriterListeners () const
 
bool HasOnlyOneListener () const
 
virtual bool GetInfo (SfxPoolItem &) const override
 
void LockModify ()
 
void UnlockModify ()
 
bool IsModifyLocked () 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 &)
 
- Public Member Functions inherited from sw::WriterListener
bool IsLast () const
 
virtual const SwCellFrameDynCastCellFrame () const
 
virtual const SwTabFrameDynCastTabFrame () const
 
virtual const SwRowFrameDynCastRowFrame () const
 
- Public Member Functions inherited from sw::BroadcasterMixin
 BroadcasterMixin ()=default
 
 BroadcasterMixin (BroadcasterMixin const &)=default
 
BroadcasterMixinoperator= (const BroadcasterMixin &)
 
SvtBroadcasterGetNotifier ()
 
- Public Member Functions inherited from SvtListener
 SvtListener ()
 
 SvtListener (const SvtListener &r)
 
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 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
 
OUString m_aEntryTypeName
 
bool m_bAutoGenerated
 
bool m_bMainEntry
 
css::uno::WeakReference< css::text::XDocumentIndexMark > m_wXDocumentIndexMark
 

Friends

class SwTextTOXMark
 
void InitCore ()
 

Additional Inherited Members

- Protected Member Functions inherited from SfxPoolItem
 SfxPoolItem (sal_uInt16 nWhich=0)
 
 SfxPoolItem (const SfxPoolItem &rCopy)
 
- Protected Member Functions inherited from SwModify
virtual void SwClientNotify (const SwModify &, const SfxHint &rHint) override
 
- Protected Member Functions inherited from SwClient
 SwClient (SwModify *pToRegisterIn)
 
SwModifyGetRegisteredInNonConst () const
 
- Protected Member Functions inherited from sw::WriterListener
 WriterListener ()
 
virtual ~WriterListener () COVERITY_NOEXCEPT_FALSE
 

Detailed Description

Definition at line 80 of file tox.hxx.

Constructor & Destructor Documentation

SwTOXMark::SwTOXMark ( )
private

pool default constructor

Definition at line 94 of file tox.cxx.

References m_nLevel.

Referenced by Clone().

SwTOXMark::SwTOXMark ( const SwTOXType pTyp)
explicit
SwTOXMark::~SwTOXMark ( )
overridevirtual

Definition at line 135 of file tox.cxx.

SwTOXMark::SwTOXMark ( const SwTOXMark rCopy)

Member Function Documentation

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

Implements SfxPoolItem.

Definition at line 152 of file tox.cxx.

References SwTOXMark().

const OUString & SwTOXMark::GetAlternativeText ( ) const
inline
const OUString & SwTOXMark::GetBookmarkName ( ) const
inline

Definition at line 582 of file tox.hxx.

References m_aBookmarkName.

const OUString & SwTOXMark::GetEntryTypeName ( ) const
inline

Definition at line 585 of file tox.hxx.

References m_aEntryTypeName.

sal_uInt16 SwTOXMark::GetLevel ( ) const
inline
OUString const & SwTOXMark::GetPrimaryKey ( ) const
inline
OUString const & SwTOXMark::GetPrimaryKeyReading ( ) const
inline
OUString const & SwTOXMark::GetSecondaryKey ( ) const
inline
OUString const & SwTOXMark::GetSecondaryKeyReading ( ) const
inline
OUString SwTOXMark::GetText ( SwRootFrame const *  pLayout) const
OUString const & SwTOXMark::GetTextReading ( ) const
inline
const SwTextTOXMark* SwTOXMark::GetTextTOXMark ( ) const
inline
SwTextTOXMark* SwTOXMark::GetTextTOXMark ( )
inline

Definition at line 164 of file tox.hxx.

const SwTOXType * SwTOXMark::GetTOXType ( ) const
inline
SAL_DLLPRIVATE css::uno::WeakReference<css::text::XDocumentIndexMark> const& SwTOXMark::GetXTOXMark ( ) const
inline

Definition at line 166 of file tox.hxx.

Referenced by SwXDocumentIndexMark::CreateXDocumentIndexMark().

void SwTOXMark::InvalidateTOXMark ( )
bool SwTOXMark::IsAlternativeText ( ) const
inline
bool SwTOXMark::IsAutoGenerated ( ) const
inline

Definition at line 155 of file tox.hxx.

bool SwTOXMark::IsMainEntry ( ) const
inline

Definition at line 158 of file tox.hxx.

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

void SwTOXMark::Notify ( const SfxHint rHint)
overrideprivatevirtual
SwTOXMark& SwTOXMark::operator= ( const SwTOXMark rCopy)
bool SwTOXMark::operator== ( const SfxPoolItem rAttr) const
overridevirtual

Implements SfxPoolItem.

Definition at line 146 of file tox.cxx.

References m_pType.

void SwTOXMark::RegisterToTOXType ( SwTOXType rMark)
void SwTOXMark::SetAlternativeText ( const OUString &  rAlt)
inline
void SwTOXMark::SetAutoGenerated ( bool  bSet)
inline

Definition at line 156 of file tox.hxx.

Referenced by SwEditShell::ApplyAutoMark().

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

Definition at line 599 of file tox.hxx.

References m_aBookmarkName.

Referenced by SwXDocumentIndexMark::setPropertyValue().

void SwTOXMark::SetEntryTypeName ( const OUString &  sName)
inline

Definition at line 604 of file tox.hxx.

References m_aEntryTypeName.

Referenced by SwXDocumentIndexMark::setPropertyValue().

void SwTOXMark::SetLevel ( sal_uInt16  nLevel)
inline
void SwTOXMark::SetMainEntry ( bool  bSet)
inline
void SwTOXMark::SetPrimaryKey ( const OUString &  rStr)
inline
void SwTOXMark::SetPrimaryKeyReading ( const OUString &  rStr)
inline
void SwTOXMark::SetSecondaryKey ( const OUString &  rStr)
inline
void SwTOXMark::SetSecondaryKeyReading ( const OUString &  rStr)
inline
void SwTOXMark::SetTextReading ( const OUString &  rStr)
inline
SAL_DLLPRIVATE void SwTOXMark::SetXTOXMark ( css::uno::Reference< css::text::XDocumentIndexMark > const &  xMark)
inline

Definition at line 168 of file tox.hxx.

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

Friends And Related Function Documentation

void InitCore ( )
friend

Definition at line 447 of file init.cxx.

friend class SwTextTOXMark
friend

Definition at line 86 of file tox.hxx.

Member Data Documentation

OUString SwTOXMark::m_aAltText
private

Definition at line 89 of file tox.hxx.

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

OUString SwTOXMark::m_aBookmarkName
private

Definition at line 101 of file tox.hxx.

Referenced by GetBookmarkName(), and SetBookmarkName().

OUString SwTOXMark::m_aEntryTypeName
private

Definition at line 102 of file tox.hxx.

Referenced by GetEntryTypeName(), and SetEntryTypeName().

OUString SwTOXMark::m_aPrimaryKey
private

Definition at line 90 of file tox.hxx.

Referenced by GetPrimaryKey(), and SetPrimaryKey().

OUString SwTOXMark::m_aPrimaryKeyReading
private

Definition at line 95 of file tox.hxx.

Referenced by GetPrimaryKeyReading(), and SetPrimaryKeyReading().

OUString SwTOXMark::m_aSecondaryKey
private

Definition at line 91 of file tox.hxx.

Referenced by GetSecondaryKey(), and SetSecondaryKey().

OUString SwTOXMark::m_aSecondaryKeyReading
private

Definition at line 96 of file tox.hxx.

Referenced by GetSecondaryKeyReading(), and SetSecondaryKeyReading().

OUString SwTOXMark::m_aTextReading
private

Definition at line 94 of file tox.hxx.

Referenced by GetTextReading(), and SetTextReading().

bool SwTOXMark::m_bAutoGenerated
private

Definition at line 103 of file tox.hxx.

bool SwTOXMark::m_bMainEntry
private

Definition at line 104 of file tox.hxx.

sal_uInt16 SwTOXMark::m_nLevel
private

Definition at line 100 of file tox.hxx.

Referenced by GetLevel(), and SetLevel().

SwTextTOXMark* SwTOXMark::m_pTextAttr
private

Definition at line 98 of file tox.hxx.

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

const SwTOXType* SwTOXMark::m_pType
private

Definition at line 88 of file tox.hxx.

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

css::uno::WeakReference<css::text::XDocumentIndexMark> SwTOXMark::m_wXDocumentIndexMark
private

Definition at line 106 of file tox.hxx.

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

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