LibreOffice Module sw (master) 1
Public Types | Public Member Functions | Protected Member Functions | List of all members
IDocumentOutlineNodes Class Referenceabstract

Provides outline nodes of a document. More...

#include <IDocumentOutlineNodes.hxx>

Inheritance diagram for IDocumentOutlineNodes:

Public Types

typedef std::vector< const SwTextNode * > tSortedOutlineNodeList

Public Member Functions

virtual tSortedOutlineNodeList::size_type getOutlineNodesCount () const =0
virtual int getOutlineLevel (const tSortedOutlineNodeList::size_type nIdx) const =0
virtual OUString getOutlineText (const tSortedOutlineNodeList::size_type nIdx, SwRootFrame const *pLayout, const bool bWithNumber=true, const bool bWithSpacesForLevel=false, const bool bWithFootnote=true) const =0
virtual SwTextNodegetOutlineNode (const tSortedOutlineNodeList::size_type nIdx) const =0
virtual bool isOutlineInLayout (tSortedOutlineNodeList::size_type nIdx, SwRootFrame const &rLayout) const =0
virtual void getOutlineNodes (IDocumentOutlineNodes::tSortedOutlineNodeList &orOutlineNodeList) const =0

Protected Member Functions

virtual ~IDocumentOutlineNodes ()

Detailed Description

Provides outline nodes of a document.

Definition at line 30 of file IDocumentOutlineNodes.hxx.

Member Typedef Documentation

◆ tSortedOutlineNodeList

Definition at line 33 of file IDocumentOutlineNodes.hxx.

Constructor & Destructor Documentation

◆ ~IDocumentOutlineNodes()

virtual IDocumentOutlineNodes::~IDocumentOutlineNodes ( )

Definition at line 51 of file IDocumentOutlineNodes.hxx.

Member Function Documentation

◆ getOutlineLevel()

virtual int IDocumentOutlineNodes::getOutlineLevel ( const tSortedOutlineNodeList::size_type  nIdx) const
pure virtual

◆ getOutlineNode()

virtual SwTextNode * IDocumentOutlineNodes::getOutlineNode ( const tSortedOutlineNodeList::size_type  nIdx) const
pure virtual

◆ getOutlineNodes()

virtual void IDocumentOutlineNodes::getOutlineNodes ( IDocumentOutlineNodes::tSortedOutlineNodeList orOutlineNodeList) const
pure virtual

◆ getOutlineNodesCount()

virtual tSortedOutlineNodeList::size_type IDocumentOutlineNodes::getOutlineNodesCount ( ) const
pure virtual

◆ getOutlineText()

virtual OUString IDocumentOutlineNodes::getOutlineText ( const tSortedOutlineNodeList::size_type  nIdx,
SwRootFrame const *  pLayout,
const bool  bWithNumber = true,
const bool  bWithSpacesForLevel = false,
const bool  bWithFootnote = true 
) const
pure virtual

◆ isOutlineInLayout()

virtual bool IDocumentOutlineNodes::isOutlineInLayout ( tSortedOutlineNodeList::size_type  nIdx,
SwRootFrame const &  rLayout 
) const
pure virtual

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