Index template. More...

#include <xfindex.hxx>

Inheritance diagram for XFIndexTemplate:

Collaboration diagram for XFIndexTemplate:

Public Member Functions
	XFIndexTemplate ()

void	SetLevel (const OUString &level)
	@descr Set template level. More...

void	SetStyleName (const OUString &style) override
	@descr Set style. More...

void	AddEntry (enumXFIndexTemplate entry, const OUString &styleName)
	@descr Add an entry in the template. More...

void	AddTabEntry (enumXFTab type, double len, sal_Unicode leader, sal_Unicode delimiter, const OUString &styleName)
	@descr Add a tab entry in the template. More...

void	AddTextEntry (const OUString &sSpan, const OUString &styleName)
	@descr Add an entry in the template. More...

virtual void	ToXml (IXFStream *pStrm) override

Public Member Functions inherited from XFContent
virtual enumXFContent	GetContentType ()
	: return the content type. More...

virtual void	SetStyleName (const OUString &style)
	: All content except XFTextContent can have a style. More...

const OUString &	GetStyleName () const
	: return the style name. More...

void	DoToXml (IXFStream *stream)

Public Member Functions inherited from salhelper::SimpleReferenceObject
	SimpleReferenceObject ()

void	acquire ()

void	release ()

Private Types
typedef std::pair< enumXFIndexTemplate, OUString >	TOCTEMPLATE_ENTRY_TYPE

Private Member Functions
void	SetTagName (const OUString &tag)
	@descr Helper function. More...

Private Attributes
OUString	m_nLevel

OUString	m_strStyle

enumXFTab	m_eTabType

double	m_fTabLength

OUString	m_strTabDelimiter

OUString	m_strTabLeader

OUString	m_strTagName

std::vector< TOCTEMPLATE_ENTRY_TYPE >	m_aEntries

std::map< sal_uInt16, OUString >	m_aTextEntries

Friends
class	XFIndex

Additional Inherited Members
Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static void *	operator new (std::size_t nSize)

static void *	operator new (std::size_t nSize, std::nothrow_t const &rNothrow)

static void	operator delete (void *pPtr)

static void	operator delete (void *pPtr, std::nothrow_t const &rNothrow)

Protected Member Functions inherited from XFContent
	XFContent ()

virtual void	ToXml (IXFStream *stream)=0

virtual	~XFContent () override

Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual	~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE

Protected Attributes inherited from XFContent
OUString	m_strStyleName

Protected Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount	m_nCount

Detailed Description

Index template.

When index update, the template is used to decide the index body.

Definition at line 78 of file xfindex.hxx.

Member Typedef Documentation

◆ TOCTEMPLATE_ENTRY_TYPE

typedef std::pair<enumXFIndexTemplate, OUString> XFIndexTemplate::TOCTEMPLATE_ENTRY_TYPE

private

Definition at line 124 of file xfindex.hxx.

Constructor & Destructor Documentation

◆ XFIndexTemplate()

XFIndexTemplate::XFIndexTemplate ( )

inline

Definition at line 177 of file xfindex.hxx.

References m_nLevel.

Member Function Documentation

◆ AddEntry()

void XFIndexTemplate::AddEntry	(	enumXFIndexTemplate	entry,
		const OUString &	styleName
	)

inline

@descr Add an entry in the template.

Definition at line 198 of file xfindex.hxx.

References m_aEntries.

Referenced by AddTabEntry(), AddTextEntry(), LwpFribSection::SetDefaultAlphaIndex(), and LwpTocSuperLayout::XFConvert().

◆ AddTabEntry()

void XFIndexTemplate::AddTabEntry	(	enumXFTab	type,
		double	len,
		sal_Unicode	leader,
		sal_Unicode	delimiter,
		const OUString &	styleName
	)

inline

@descr Add a tab entry in the template.

Definition at line 204 of file xfindex.hxx.

References AddEntry(), enumXFIndexTemplateTab, m_eTabType, m_fTabLength, m_strTabDelimiter, m_strTabLeader, and type.

Referenced by LwpTocSuperLayout::XFConvert().

◆ AddTextEntry()

void XFIndexTemplate::AddTextEntry	(	const OUString &	sSpan,
		const OUString &	styleName
	)

inline

@descr Add an entry in the template.

Definition at line 214 of file xfindex.hxx.

References AddEntry(), enumXFIndexTemplateSpan, m_aEntries, and m_aTextEntries.

Referenced by LwpTocSuperLayout::XFConvert().

◆ SetLevel()

void XFIndexTemplate::SetLevel ( const OUString & level )

inline

@descr Set template level.

Definition at line 184 of file xfindex.hxx.

References m_nLevel.

Referenced by XFIndex::AddTemplate(), and LwpTocSuperLayout::XFConvert().

◆ SetStyleName()

void XFIndexTemplate::SetStyleName ( const OUString & style )

inlineoverridevirtual

@descr Set style.

Reimplemented from XFContent.

Definition at line 188 of file xfindex.hxx.

References m_strStyle.

Referenced by XFIndex::AddTemplate().

◆ SetTagName()

void XFIndexTemplate::SetTagName ( const OUString & tag )

inlineprivate

@descr Helper function.

Definition at line 193 of file xfindex.hxx.

References m_strTagName.

◆ ToXml()

void XFIndexTemplate::ToXml ( IXFStream * pStrm )

overridevirtual

Friends And Related Function Documentation

◆ XFIndex

friend class XFIndex

friend

Definition at line 115 of file xfindex.hxx.

Member Data Documentation

◆ m_aEntries

std::vector<TOCTEMPLATE_ENTRY_TYPE> XFIndexTemplate::m_aEntries

private

Definition at line 125 of file xfindex.hxx.

Referenced by AddEntry(), AddTextEntry(), and ToXml().

◆ m_aTextEntries

std::map<sal_uInt16, OUString> XFIndexTemplate::m_aTextEntries

private

Definition at line 126 of file xfindex.hxx.

Referenced by AddTextEntry(), and ToXml().

◆ m_eTabType

enumXFTab XFIndexTemplate::m_eTabType

private

Definition at line 119 of file xfindex.hxx.

Referenced by AddTabEntry(), and ToXml().

◆ m_fTabLength

double XFIndexTemplate::m_fTabLength

private

Definition at line 120 of file xfindex.hxx.

Referenced by AddTabEntry(), and ToXml().

◆ m_nLevel

OUString XFIndexTemplate::m_nLevel

private

Definition at line 117 of file xfindex.hxx.

Referenced by SetLevel(), ToXml(), and XFIndexTemplate().

◆ m_strStyle

OUString XFIndexTemplate::m_strStyle

private

Definition at line 118 of file xfindex.hxx.

Referenced by SetStyleName(), and ToXml().

◆ m_strTabDelimiter

OUString XFIndexTemplate::m_strTabDelimiter

private

Definition at line 121 of file xfindex.hxx.

Referenced by AddTabEntry(), and ToXml().

◆ m_strTabLeader

OUString XFIndexTemplate::m_strTabLeader

private

Definition at line 122 of file xfindex.hxx.

Referenced by AddTabEntry(), and ToXml().

◆ m_strTagName

OUString XFIndexTemplate::m_strTagName

private

Definition at line 123 of file xfindex.hxx.

Referenced by SetTagName(), and ToXml().

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TOCTEMPLATE_ENTRY_TYPE

Constructor & Destructor Documentation

◆ XFIndexTemplate()

Member Function Documentation

◆ AddEntry()

◆ AddTabEntry()

◆ AddTextEntry()

◆ SetLevel()

◆ SetStyleName()

◆ SetTagName()

◆ ToXml()

Friends And Related Function Documentation

◆ XFIndex

Member Data Documentation

◆ m_aEntries

◆ m_aTextEntries

◆ m_eTabType

◆ m_fTabLength

◆ m_nLevel

◆ m_strStyle

◆ m_strTabDelimiter

◆ m_strTabLeader

◆ m_strTagName