Index, include index template, index body. More...

#include <xfindex.hxx>

Inheritance diagram for XFIndex:

Collaboration diagram for XFIndex:

Public Member Functions
	XFIndex ()

virtual	~XFIndex () override

void	SetIndexType (enumXFIndex type)
	@descr Set index type. More...

void	AddTemplate (const OUString &level, const OUString &style, XFIndexTemplate *templ)
	@descr Add index template entry. More...

void	SetProtected (bool protect)
	@descr Set if protected index to prevent handy-revise. More...

void	SetSeparator (bool sep)
	@descr Set separator. More...

virtual void	ToXml (IXFStream *pStrm) override
	@descr Output to OOo model or local file. More...

void	AddTocSource (sal_uInt16 nLevel, const OUString &sStyleName)

Public Member Functions inherited from XFContentContainer
	XFContentContainer ()

virtual	~XFContentContainer () override
	@descr Destructure, all contents will be deleted too. More...

virtual void	Add (XFContent *pContent)
	@descr Add content. More...

rtl::Reference< XFContent >	GetLastContent ()

void	RemoveLastContent ()

void	Add (const OUString &text)
	@descr convenience function for add text content. More...

int	GetCount () const
	@descr return the number of contents in the container. More...

rtl::Reference< XFContent >	GetContent (sal_uInt32 index) const
	@descr get content by index. More...

void	Reset ()
	@descr clear all contents in the container. More...

rtl::Reference< XFContent >	FindFirstContent (enumXFContent type)
	@descr helper function, find first content by type. More...

virtual enumXFContent	GetContentType () override
	@descr return the content type. More...

virtual void	ToXml (IXFStream *pStrm) override
	@descr Output to OOo model or local file. More...

bool	HierarchyContains (const XFContent *pContent) const

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 Attributes
enumXFIndex	m_eType

OUString	m_strTitle

bool	m_bProtect

bool	m_bSeparator

std::vector< rtl::Reference< XFIndexTemplate > >	m_aTemplates

std::vector< OUString >	m_aTOCSource [MAX_TOC_LEVEL+1]

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, include index template, index body.

Definition at line 133 of file xfindex.hxx.

Constructor & Destructor Documentation

◆ XFIndex()

XFIndex::XFIndex ( )

Definition at line 63 of file xfindex.cxx.

References m_eType.

◆ ~XFIndex()

XFIndex::~XFIndex ( )

overridevirtual

Definition at line 69 of file xfindex.cxx.

Member Function Documentation

◆ AddTemplate()

void XFIndex::AddTemplate	(	const OUString &	level,
		const OUString &	style,
		XFIndexTemplate *	templ
	)

@descr Add index template entry.

Definition at line 73 of file xfindex.cxx.

References enumXFIndexTOC, m_aTemplates, m_eType, XFIndexTemplate::SetLevel(), and XFIndexTemplate::SetStyleName().

Referenced by LwpFribSection::SetDefaultAlphaIndex().

◆ AddTocSource()

void XFIndex::AddTocSource	(	sal_uInt16	nLevel,
		const OUString &	sStyleName
	)

Definition at line 93 of file xfindex.cxx.

References m_aTOCSource, and MAX_TOC_LEVEL.

Referenced by LwpTocSuperLayout::AddSourceStyle().

◆ SetIndexType()

void XFIndex::SetIndexType ( enumXFIndex type )

inline

@descr Set index type.

Definition at line 222 of file xfindex.hxx.

References m_eType, and type.

Referenced by LwpFribSection::ParseSection().

◆ SetProtected()

void XFIndex::SetProtected ( bool protect )

@descr Set if protected index to prevent handy-revise.

Definition at line 83 of file xfindex.cxx.

References m_bProtect.

◆ SetSeparator()

void XFIndex::SetSeparator ( bool sep )

@descr Set separator.

Definition at line 88 of file xfindex.cxx.

References m_bSeparator.

Referenced by LwpFribSection::SetDefaultAlphaIndex().

◆ ToXml()

void XFIndex::ToXml ( IXFStream * pStrm )

overridevirtual

@descr Output to OOo model or local file.

Reimplemented from XFContentContainer.

Definition at line 103 of file xfindex.cxx.

References IXFAttrList::AddAttribute(), IXFStream::Characters(), IXFAttrList::Clear(), IXFStream::EndElement(), enumXFIndexAlphabetical, enumXFIndexIllustration, enumXFIndexObject, enumXFIndexTableIndex, enumXFIndexTOC, enumXFIndexUserIndex, IXFStream::GetAttrList(), XFContent::GetStyleName(), i, m_aTemplates, m_aTOCSource, m_bProtect, m_bSeparator, m_eType, m_strTitle, MAX_TOC_LEVEL, IXFStream::StartElement(), and XFContentContainer::ToXml().

Member Data Documentation

◆ m_aTemplates

std::vector<rtl::Reference<XFIndexTemplate> > XFIndex::m_aTemplates

private

Definition at line 171 of file xfindex.hxx.

Referenced by AddTemplate(), and ToXml().

◆ m_aTOCSource

std::vector<OUString> XFIndex::m_aTOCSource[MAX_TOC_LEVEL+1]

private

Definition at line 174 of file xfindex.hxx.

Referenced by AddTocSource(), and ToXml().

◆ m_bProtect

bool XFIndex::m_bProtect

private

Definition at line 168 of file xfindex.hxx.

Referenced by SetProtected(), and ToXml().

◆ m_bSeparator

bool XFIndex::m_bSeparator

private

Definition at line 169 of file xfindex.hxx.

Referenced by SetSeparator(), and ToXml().

◆ m_eType

enumXFIndex XFIndex::m_eType

private

Definition at line 166 of file xfindex.hxx.

Referenced by AddTemplate(), SetIndexType(), and ToXml().

◆ m_strTitle

OUString XFIndex::m_strTitle

private

Definition at line 167 of file xfindex.hxx.

Referenced by ToXml().

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XFIndex()

◆ ~XFIndex()

Member Function Documentation

◆ AddTemplate()

◆ AddTocSource()

◆ SetIndexType()

◆ SetProtected()

◆ SetSeparator()

◆ ToXml()

Member Data Documentation

◆ m_aTemplates

◆ m_aTOCSource

◆ m_bProtect

◆ m_bSeparator

◆ m_eType

◆ m_strTitle