LibreOffice Module sw (master) 1
Public Member Functions | Private Attributes | List of all members
docx::FootnotesList Class Reference

Remember footnotes/endnotes so that we can dump them in one go. More...

#include <docxfootnotes.hxx>

Public Member Functions

 FootnotesList ()
 
void add (const SwFormatFootnote &rFootnote)
 
const SwFormatFootnotegetCurrent (sal_Int32 &rId)
 Return the current footnote/endnote and clear the 'current' state. More...
 
const FootnotesVectorgetVector () const
 Return all the footnotes/endnotes. More...
 
bool isEmpty () const
 Do we have any footnotes/endnotes at all? More...
 

Private Attributes

sal_Int32 m_nCurrent
 The current footnote, that was not written yet. More...
 
FootnotesVector m_aFootnotes
 List of the footnotes. More...
 

Detailed Description

Remember footnotes/endnotes so that we can dump them in one go.

Also remember the last added footnote Id to be able to write it in the DocxAttributeOutput::EndRunProperties() method.

Definition at line 38 of file docxfootnotes.hxx.

Constructor & Destructor Documentation

◆ FootnotesList()

docx::FootnotesList::FootnotesList ( )
inline

Definition at line 46 of file docxfootnotes.hxx.

Member Function Documentation

◆ add()

void docx::FootnotesList::add ( const SwFormatFootnote rFootnote)
inline

Definition at line 48 of file docxfootnotes.hxx.

References m_aFootnotes, and m_nCurrent.

◆ getCurrent()

const SwFormatFootnote * docx::FootnotesList::getCurrent ( sal_Int32 &  rId)
inline

Return the current footnote/endnote and clear the 'current' state.

Definition at line 55 of file docxfootnotes.hxx.

References m_aFootnotes, and m_nCurrent.

◆ getVector()

const FootnotesVector & docx::FootnotesList::getVector ( ) const
inline

Return all the footnotes/endnotes.

Definition at line 75 of file docxfootnotes.hxx.

References m_aFootnotes.

◆ isEmpty()

bool docx::FootnotesList::isEmpty ( ) const
inline

Do we have any footnotes/endnotes at all?

Definition at line 81 of file docxfootnotes.hxx.

References m_aFootnotes.

Member Data Documentation

◆ m_aFootnotes

FootnotesVector docx::FootnotesList::m_aFootnotes
private

List of the footnotes.

Definition at line 43 of file docxfootnotes.hxx.

Referenced by add(), getCurrent(), getVector(), and isEmpty().

◆ m_nCurrent

sal_Int32 docx::FootnotesList::m_nCurrent
private

The current footnote, that was not written yet.

Definition at line 40 of file docxfootnotes.hxx.

Referenced by add(), and getCurrent().


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