Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
STOFFSpreadsheetListener Class Referencefinal

This class contents the main functions needed to create a spreadsheet processing Document. More...

`#include <STOFFSpreadsheetListener.hxx>`

Inheritance diagram for STOFFSpreadsheetListener:

## Public Member Functions
| STOFFSpreadsheetListener (STOFFListManagerPtr &listManager, std::vector< STOFFPageSpan > const &pageList, librevenge::RVNGSpreadsheetInterface *documentInterface)
| constructor
| ~STOFFSpreadsheetListener () final
| destructor
Type | getType () const final
| returns the listener type
void | setDocumentLanguage (std::string locale) final
| sets the document language
void | setDocumentMetaData (const librevenge::RVNGPropertyList &list) final
| sets the document meta data
void | startDocument () final
| starts the document
void | endDocument (bool sendDelayedSubDoc=true) final
| ends the document
bool | isDocumentStarted () const final
| returns true if a document is opened
void | handleSubDocument (STOFFSubDocumentPtr subDocument, libstoff::SubDocumentType subDocumentType) final
| function called to add a subdocument
bool | isSubDocumentOpened (libstoff::SubDocumentType &subdocType) const final
| returns try if a subdocument is open
bool | openFrame (STOFFFrameStyle const &frame, STOFFGraphicStyle const &style=STOFFGraphicStyle()) final
| tries to open a frame
void | closeFrame () final
| tries to close a frame
bool | openGroup (STOFFFrameStyle const &frame) final
| open a group (not implemented)
void | closeGroup () final
| close a group (not implemented)
bool | canWriteText () const final
| returns true if we can add text data
bool | isPageSpanOpened () const final
| returns true if a page is opened
STOFFPageSpan const & | getPageSpan () final
| returns the current page span
bool | openHeader (librevenge::RVNGPropertyList const &extras) final
| open a header (interaction with STOFFPageSpan which fills the parameters for openHeader)
bool | openFooter (librevenge::RVNGPropertyList const &extras) final
| open a footer (interaction with STOFFPageSpan which fills the parameters for openFooter)
bool | closeHeader () final
| close a header
bool | closeFooter () final
| close a footer
bool | insertHeaderRegion (STOFFSubDocumentPtr subDocument, librevenge::RVNGString const &which) final
| insert a header
bool | insertFooterRegion (STOFFSubDocumentPtr subDocument, librevenge::RVNGString const &which) final
| insert a footer
bool | isHeaderFooterOpened () const final
| returns true if the header/footer is open
void | openSheet (std::vector< float > const &colWidth, librevenge::RVNGUnit unit, std::vector< int > const &repeatColWidthNumber=std::vector< int >(), librevenge::RVNGString const &name="")
| open a sheet
void | closeSheet ()
| closes this sheet
void | openSheetRow (float h, librevenge::RVNGUnit unit, int numRepeated=1)
| open a row with given height ( if h < 0.0, set min-row-height = -h )
void | closeSheetRow ()
| closes this row
void | openSheetCell (STOFFCell const &cell, STOFFCellContent const &content, int numRepeated=1)
| open a cell
void | closeSheetCell ()
| close a cell
void | insertChart (STOFFFrameStyle const &frame, STOFFChart &chart, STOFFGraphicStyle const &style=STOFFGraphicStyle())
| adds a chart in given position
void | insertChar (uint8_t character) final
| adds a basic character, ..
void | insertUnicode (uint32_t character) final
| adds an unicode character.
void | insertUnicodeString (librevenge::RVNGString const &str) final
| adds a unicode string
void | insertTab () final
| adds a tab
void | insertEOL (bool softBreak=false) final
| adds an end of line ( by default an hard one)
void | setFont (STOFFFont const &font) final
| sets the font
STOFFFont const & | getFont () const final
| returns the actual font
bool | isParagraphOpened () const final
| returns true if a paragraph or a list is opened
void | setParagraph (STOFFParagraph const &paragraph) final
| sets the paragraph
STOFFParagraph const & | getParagraph () const final
| returns the actual paragraph
void | defineStyle (STOFFFont const &style) final
| defines a font styles
bool | isFontStyleDefined (librevenge::RVNGString const &name) const final
| check if a font style with a display name is already defined
void | defineStyle (STOFFGraphicStyle const &style) final
| defines a graphic styles
bool | isGraphicStyleDefined (librevenge::RVNGString const &name) const final
| check if a graphic style with a display name is already defined
void | defineStyle (STOFFParagraph const &style) final
| defines a paragraph styles
bool | isParagraphStyleDefined (librevenge::RVNGString const &name) const final
| check if a paragraph style with a display name is already defined
void | insertField (STOFFField const &field) final
| adds a field type
void | openLink (STOFFLink const &link) final
| open a link
void | closeLink () final
| close a link
void | insertNote (STOFFNote const &note, STOFFSubDocumentPtr &subDocument) final
| insert a note
void | insertComment (STOFFSubDocumentPtr &subDocument, librevenge::RVNGString const &creator="", librevenge::RVNGString const &date="") final
| adds comment
void | insertPicture (STOFFFrameStyle const &frame, STOFFEmbeddedObject const &picture, STOFFGraphicStyle const &style=STOFFGraphicStyle()) final
| adds a picture with potential various representationin given position
void | insertEquation (STOFFFrameStyle const &frame, librevenge::RVNGString const &equation, STOFFGraphicStyle const &style=STOFFGraphicStyle()) final
| adds a equation given a position
void | insertShape (STOFFFrameStyle const &frame, STOFFGraphicShape const &shape, STOFFGraphicStyle const &style) final
| adds a shape picture in given position
void | insertTextBox (STOFFFrameStyle const &frame, STOFFSubDocumentPtr subDocument, STOFFGraphicStyle const &frameStyle=STOFFGraphicStyle()) final
| adds a textbox in given position
void | openTable (STOFFTable const &table) final
| open a table
void | closeTable () final
| closes this table
void | openTableRow (float h, librevenge::RVNGUnit unit, bool headerRow=false) final
| open a row with given height ( if h < 0.0, set min-row-height = -h )
void | closeTableRow () final
| closes this row
void | openTableCell (STOFFCell const &cell) final
| open a cell
void | closeTableCell () final
| close a cell
void | addCoveredTableCell (STOFFVec2i const &pos) final
| add covered cell
void | addEmptyTableCell (STOFFVec2i const &pos, STOFFVec2i span=STOFFVec2i(1, 1)) final
| add empty cell
bool | canOpenSectionAddBreak () const final
| returns true if we can add open a section, add page break, ...
bool | isSectionOpened () const final
| returns true if a section is opened
STOFFSection const & | getSection () const final
| returns the actual section
bool | openSection (STOFFSection const &section) final
| open a section if possible
bool | closeSection () final
| close a section
void | insertBreak (BreakType breakType) final
| inserts a break type: ColumBreak, PageBreak, ..
Public Member Functions inherited from STOFFListener
virtual | ~STOFFListener ()
| destructor
STOFFListManagerPtr | getListManager () const
| return the list manager
void | insertUnicodeList (std::vector< uint32_t > const &list)
| try to insert a list of unicode character

## Protected Member Functions
void | _openPageSpan (bool sendHeaderFooters=true)
| does open a new page (low level)
void | _closePageSpan ()
| does close a page (low level)
void | _startSubDocument ()
void | _endSubDocument ()
void | _handleFrameParameters (librevenge::RVNGPropertyList &propList, STOFFFrameStyle const &frame)
void | _openParagraph ()
void | _closeParagraph ()
void | _resetParagraphState (const bool isListElement=false)
void | _openListElement ()
| open a list level
void | _closeListElement ()
| close a list level
void | _changeList ()
| update the list so that it corresponds to the actual level
int | _getListId () const
| low level: find a list id which corresponds to actual list and a change of level.
void | _openSpan ()
void | _closeSpan ()
void | _flushText ()
void | _flushDeferredTabs ()
std::shared_ptr< STOFFSpreadsheetListenerInternal::State > | _pushParsingState ()
| creates a new parsing state (copy of the actual state)
void | _popParsingState ()
| resets the previous parsing state
Protected Member Functions inherited from STOFFListener
| STOFFListener (STOFFListManagerPtr &listManager)
| constructor

## Protected Attributes
std::shared_ptr< STOFFSpreadsheetListenerInternal::DocumentState > | m_ds
| the main parse state
std::shared_ptr< STOFFSpreadsheetListenerInternal::State > | m_ps
| the actual local parse state
std::vector< std::shared_ptr< STOFFSpreadsheetListenerInternal::State > > | m_psStack
| stack of local state
librevenge::RVNGSpreadsheetInterface * | m_documentInterface
| the document interface
Protected Attributes inherited from STOFFListener
STOFFListManagerPtr | m_listManager
| the list manager

## Private Member Functions
| STOFFSpreadsheetListener (const STOFFSpreadsheetListener &)
| copy constructor (unimplemented)
STOFFSpreadsheetListener & | operator= (const STOFFSpreadsheetListener &)
| operator= (unimplemented)

## Additional Inherited Members
Public Types inherited from STOFFListener
enum | Type { Graphic , Presentation , Spreadsheet , Text }
| the listener type More...
enum | BreakType { PageBreak =0 , SoftPageBreak , ColumnBreak }
| the different break type More...

## Detailed Description

This class contents the main functions needed to create a spreadsheet processing Document.

## Constructor & Destructor Documentation

## ◆ STOFFSpreadsheetListener() [1/2]

STOFFSpreadsheetListener::STOFFSpreadsheetListener | ( | STOFFListManagerPtr & | listManager,
|  | std::vector< STOFFPageSpan > const & | pageList,
|  | librevenge::RVNGSpreadsheetInterface * | documentInterface )

constructor

## ◆ ~STOFFSpreadsheetListener()

STOFFSpreadsheetListener::~STOFFSpreadsheetListener | ( |  | ) |
| final

destructor

## ◆ STOFFSpreadsheetListener() [2/2]

STOFFSpreadsheetListener::STOFFSpreadsheetListener | ( | const STOFFSpreadsheetListener & |  | ) |
| private

copy constructor (unimplemented)

## Member Function Documentation

## ◆ _changeList()

void STOFFSpreadsheetListener::_changeList | ( |  | ) |
| protected

update the list so that it corresponds to the actual level

Referenced by _endSubDocument(), _openSpan(), closeTableCell(), endDocument(), and insertNote().

## ◆ _closeListElement()

void STOFFSpreadsheetListener::_closeListElement | ( |  | ) |
| protected

close a list level

Referenced by _closeParagraph().

## ◆ _closePageSpan()

void STOFFSpreadsheetListener::_closePageSpan | ( |  | ) |
| protected

does close a page (low level)

Referenced by endDocument(), and insertBreak().

## ◆ _closeParagraph()

void STOFFSpreadsheetListener::_closeParagraph | ( |  | ) |
| protected

Referenced by _changeList(), _endSubDocument(), closeSheetCell(), closeTableCell(), endDocument(), insertBreak(), insertComment(), insertEOL(), insertNote(), openSheet(), and openTable().

## ◆ _closeSpan()

void STOFFSpreadsheetListener::_closeSpan | ( |  | ) |
| protected

Referenced by _closeListElement(), _closeParagraph(), _endSubDocument(), closeLink(), insertComment(), insertNote(), and setFont().

## ◆ _endSubDocument()

void STOFFSpreadsheetListener::_endSubDocument | ( |  | ) |
| protected

Referenced by closeSheet(), closeTable(), handleSubDocument(), and insertChart().

## ◆ _flushDeferredTabs()

void STOFFSpreadsheetListener::_flushDeferredTabs | ( |  | ) |
| protected

Referenced by insertChar(), insertEOL(), insertField(), insertTab(), insertUnicode(), insertUnicodeString(), and openLink().

## ◆ _flushText()

void STOFFSpreadsheetListener::_flushText | ( |  | ) |
| protected

Referenced by _closeSpan(), insertComment(), insertEOL(), insertField(), insertNote(), insertShape(), insertTab(), openFrame(), and openLink().

## ◆ _getListId()

int STOFFSpreadsheetListener::_getListId | ( |  | ) | const
| protected

low level: find a list id which corresponds to actual list and a change of level.

Note
  called when the list id is not set

Referenced by _changeList().

## ◆ _handleFrameParameters()

void STOFFSpreadsheetListener::_handleFrameParameters | ( | librevenge::RVNGPropertyList & | propList,
|  | STOFFFrameStyle const & | frame )
| protected

Referenced by openFrame().

## ◆ _openListElement()

void STOFFSpreadsheetListener::_openListElement | ( |  | ) |
| protected

open a list level

Referenced by _openSpan().

## ◆ _openPageSpan()

void STOFFSpreadsheetListener::_openPageSpan | ( | bool | sendHeaderFooters = true | ) |
| protected

does open a new page (low level)

Referenced by endDocument(), getPageSpan(), and openSheet().

## ◆ _openParagraph()

void STOFFSpreadsheetListener::_openParagraph | ( |  | ) |
| protected

Referenced by _openSpan(), insertComment(), insertNote(), insertShape(), and openFrame().

## ◆ _openSpan()

void STOFFSpreadsheetListener::_openSpan | ( |  | ) |
| protected

Referenced by _flushDeferredTabs(), endDocument(), handleSubDocument(), insertBreak(), insertChar(), insertEOL(), insertField(), insertShape(), insertUnicode(), insertUnicodeString(), openFrame(), and openLink().

## ◆ _popParsingState()

void STOFFSpreadsheetListener::_popParsingState | ( |  | ) |
| protected

resets the previous parsing state

Referenced by closeFooter(), closeHeader(), closeLink(), closeSheet(), closeSheetCell(), closeTable(), handleSubDocument(), and insertChart().

## ◆ _pushParsingState()

std::shared_ptr< STOFFSpreadsheetListenerInternal::State > STOFFSpreadsheetListener::_pushParsingState | ( |  | ) |
| protected

creates a new parsing state (copy of the actual state)

Returns
  the old one

Referenced by handleSubDocument(), insertChart(), openFooter(), openHeader(), openLink(), openSheet(), openSheetCell(), and openTable().

## ◆ _resetParagraphState()

void STOFFSpreadsheetListener::_resetParagraphState | ( | const bool | isListElement = false | ) |
| protected

Referenced by _openListElement(), and _openParagraph().

## ◆ _startSubDocument()

void STOFFSpreadsheetListener::_startSubDocument | ( |  | ) |
| protected

Referenced by handleSubDocument(), insertChart(), openSheet(), and openTable().

## ◆ addCoveredTableCell()

void STOFFSpreadsheetListener::addCoveredTableCell | ( | STOFFVec2i const & | pos | ) |
| final virtual

add covered cell

Implements STOFFListener.

## ◆ addEmptyTableCell()

void STOFFSpreadsheetListener::addEmptyTableCell | ( | STOFFVec2i const & | pos,
|  | STOFFVec2i | span = STOFFVec2i(1,1) )
| final virtual

add empty cell

Implements STOFFListener.

## ◆ canOpenSectionAddBreak()

bool STOFFSpreadsheetListener::canOpenSectionAddBreak | ( |  | ) | const
| inline final virtual

returns true if we can add open a section, add page break, ...

Implements STOFFListener.

## ◆ canWriteText()

bool STOFFSpreadsheetListener::canWriteText | ( |  | ) | const
| final virtual

returns true if we can add text data

Implements STOFFListener.

Referenced by insertComment(), and insertNote().

## ◆ closeFooter()

bool STOFFSpreadsheetListener::closeFooter | ( |  | ) |
| final virtual

close a footer

Implements STOFFListener.

## ◆ closeFrame()

void STOFFSpreadsheetListener::closeFrame | ( |  | ) |
| final virtual

tries to close a frame

Implements STOFFListener.

Referenced by insertChart(), insertEquation(), insertPicture(), and insertTextBox().

## ◆ closeGroup()

void STOFFSpreadsheetListener::closeGroup | ( |  | ) |
| final virtual

close a group (not implemented)

Implements STOFFListener.

## ◆ closeHeader()

bool STOFFSpreadsheetListener::closeHeader | ( |  | ) |
| final virtual

close a header

Implements STOFFListener.

## ◆ closeLink()

void STOFFSpreadsheetListener::closeLink | ( |  | ) |
| final virtual

close a link

Implements STOFFListener.

## ◆ closeSection()

bool STOFFSpreadsheetListener::closeSection | ( |  | ) |
| final virtual

close a section

Implements STOFFListener.

## ◆ closeSheet()

void STOFFSpreadsheetListener::closeSheet | ( |  | ) |

closes this sheet

Referenced by endDocument().

## ◆ closeSheetCell()

void STOFFSpreadsheetListener::closeSheetCell | ( |  | ) |

close a cell

Referenced by openSheetCell().

## ◆ closeSheetRow()

void STOFFSpreadsheetListener::closeSheetRow | ( |  | ) |

closes this row

## ◆ closeTable()

void STOFFSpreadsheetListener::closeTable | ( |  | ) |
| final virtual

closes this table

Implements STOFFListener.

Referenced by _endSubDocument(), and endDocument().

## ◆ closeTableCell()

void STOFFSpreadsheetListener::closeTableCell | ( |  | ) |
| final virtual

close a cell

Implements STOFFListener.

Referenced by addCoveredTableCell(), addEmptyTableCell(), and openTableCell().

## ◆ closeTableRow()

void STOFFSpreadsheetListener::closeTableRow | ( |  | ) |
| final virtual

closes this row

Implements STOFFListener.

## ◆ defineStyle() [1/3]

void STOFFSpreadsheetListener::defineStyle | ( | STOFFFont const & | style | ) |
| final virtual

defines a font styles

Implements STOFFListener.

## ◆ defineStyle() [2/3]

void STOFFSpreadsheetListener::defineStyle | ( | STOFFGraphicStyle const & | style | ) |
| final virtual

defines a graphic styles

Implements STOFFListener.

## ◆ defineStyle() [3/3]

void STOFFSpreadsheetListener::defineStyle | ( | STOFFParagraph const & | style | ) |
| final virtual

defines a paragraph styles

Implements STOFFListener.

## ◆ endDocument()

void STOFFSpreadsheetListener::endDocument | ( | bool | sendDelayedSubDoc = true | ) |
| final virtual

ends the document

Implements STOFFListener.

## ◆ getFont()

STOFFFont const & STOFFSpreadsheetListener::getFont | ( |  | ) | const
| final virtual

returns the actual font

Implements STOFFListener.

## ◆ getPageSpan()

STOFFPageSpan const & STOFFSpreadsheetListener::getPageSpan | ( |  | ) |
| final virtual

returns the current page span

Note
  this forces the opening of a new page if no page is opened.

Implements STOFFListener.

## ◆ getParagraph()

STOFFParagraph const & STOFFSpreadsheetListener::getParagraph | ( |  | ) | const
| final virtual

returns the actual paragraph

Implements STOFFListener.

## ◆ getSection()

STOFFSection const & STOFFSpreadsheetListener::getSection | ( |  | ) | const
| final virtual

returns the actual section

Implements STOFFListener.

## ◆ getType()

Type STOFFSpreadsheetListener::getType | ( |  | ) | const
| inline final virtual

returns the listener type

Implements STOFFListener.

## ◆ handleSubDocument()

void STOFFSpreadsheetListener::handleSubDocument | ( | STOFFSubDocumentPtr | subDocument,
|  | libstoff::SubDocumentType | subDocumentType )
| final virtual

function called to add a subdocument

Implements STOFFListener.

Referenced by insertComment(), insertFooterRegion(), insertHeaderRegion(), insertNote(), and insertTextBox().

## ◆ insertBreak()

void STOFFSpreadsheetListener::insertBreak | ( | STOFFSpreadsheetListener::BreakType | type | ) |
| final virtual

inserts a break type: ColumBreak, PageBreak, ..

Implements STOFFListener.

## ◆ insertChar()

void STOFFSpreadsheetListener::insertChar | ( | uint8_t | character | ) |
| final virtual

adds a basic character, ..

Implements STOFFListener.

## ◆ insertChart()

void STOFFSpreadsheetListener::insertChart | ( | STOFFFrameStyle const & | frame,
|  | STOFFChart & | chart,
|  | STOFFGraphicStyle const & | style = STOFFGraphicStyle() )

adds a chart in given position

## ◆ insertComment()

void STOFFSpreadsheetListener::insertComment | ( | STOFFSubDocumentPtr & | subDocument,
|  | librevenge::RVNGString const & | creator = "",
|  | librevenge::RVNGString const & | date = "" )
| final virtual

adds comment

Implements STOFFListener.

## ◆ insertEOL()

void STOFFSpreadsheetListener::insertEOL | ( | bool | softBreak = false | ) |
| final virtual

adds an end of line ( by default an hard one)

Implements STOFFListener.

## ◆ insertEquation()

void STOFFSpreadsheetListener::insertEquation | ( | STOFFFrameStyle const & | frame,
|  | librevenge::RVNGString const & | equation,
|  | STOFFGraphicStyle const & | style = STOFFGraphicStyle() )
| final virtual

adds a equation given a position

Implements STOFFListener.

## ◆ insertField()

void STOFFSpreadsheetListener::insertField | ( | STOFFField const & | field | ) |
| final virtual

adds a field type

Implements STOFFListener.

## ◆ insertFooterRegion()

bool STOFFSpreadsheetListener::insertFooterRegion | ( | STOFFSubDocumentPtr | subDocument,
|  | librevenge::RVNGString const & | which )
| final virtual

insert a footer

Implements STOFFListener.

## ◆ insertHeaderRegion()

bool STOFFSpreadsheetListener::insertHeaderRegion | ( | STOFFSubDocumentPtr | subDocument,
|  | librevenge::RVNGString const & | which )
| final virtual

insert a header

Implements STOFFListener.

## ◆ insertNote()

void STOFFSpreadsheetListener::insertNote | ( | STOFFNote const & | note,
|  | STOFFSubDocumentPtr & | subDocument )
| final virtual

insert a note

Must not happen excepted in corrupted document, so we do the minimum. Note that we have no choice, either we begin by closing the paragraph, ... or we reprogram handleSubDocument.

Implements STOFFListener.

## ◆ insertPicture()

void STOFFSpreadsheetListener::insertPicture | ( | STOFFFrameStyle const & | frame,
|  | STOFFEmbeddedObject const & | picture,
|  | STOFFGraphicStyle const & | style = STOFFGraphicStyle() )
| final virtual

adds a picture with potential various representationin given position

Implements STOFFListener.

## ◆ insertShape()

void STOFFSpreadsheetListener::insertShape | ( | STOFFFrameStyle const & | frame,
|  | STOFFGraphicShape const & | shape,
|  | STOFFGraphicStyle const & | style )
| final virtual

adds a shape picture in given position

Implements STOFFListener.

## ◆ insertTab()

void STOFFSpreadsheetListener::insertTab | ( |  | ) |
| final virtual

adds a tab

Implements STOFFListener.

## ◆ insertTextBox()

void STOFFSpreadsheetListener::insertTextBox | ( | STOFFFrameStyle const & | frame,
|  | STOFFSubDocumentPtr | subDocument,
|  | STOFFGraphicStyle const & | frameStyle = STOFFGraphicStyle() )
| final virtual

adds a textbox in given position

Implements STOFFListener.

## ◆ insertUnicode()

void STOFFSpreadsheetListener::insertUnicode | ( | uint32_t | character | ) |
| final virtual

adds an unicode character.

By convention if character=0xfffd(undef), no character is added

Implements STOFFListener.

Referenced by insertChar().

## ◆ insertUnicodeString()

void STOFFSpreadsheetListener::insertUnicodeString | ( | librevenge::RVNGString const & | str | ) |
| final virtual

adds a unicode string

Implements STOFFListener.

## ◆ isDocumentStarted()

bool STOFFSpreadsheetListener::isDocumentStarted | ( |  | ) | const
| final virtual

returns true if a document is opened

Implements STOFFListener.

## ◆ isFontStyleDefined()

bool STOFFSpreadsheetListener::isFontStyleDefined | ( | librevenge::RVNGString const & | name | ) | const
| final virtual

check if a font style with a display name is already defined

Implements STOFFListener.

## ◆ isGraphicStyleDefined()

bool STOFFSpreadsheetListener::isGraphicStyleDefined | ( | librevenge::RVNGString const & | name | ) | const
| final virtual

check if a graphic style with a display name is already defined

Implements STOFFListener.

## ◆ isHeaderFooterOpened()

bool STOFFSpreadsheetListener::isHeaderFooterOpened | ( |  | ) | const
| final virtual

returns true if the header/footer is open

Implements STOFFListener.

## ◆ isPageSpanOpened()

bool STOFFSpreadsheetListener::isPageSpanOpened | ( |  | ) | const
| final virtual

returns true if a page is opened

Implements STOFFListener.

## ◆ isParagraphOpened()

bool STOFFSpreadsheetListener::isParagraphOpened | ( |  | ) | const
| final virtual

returns true if a paragraph or a list is opened

Implements STOFFListener.

## ◆ isParagraphStyleDefined()

bool STOFFSpreadsheetListener::isParagraphStyleDefined | ( | librevenge::RVNGString const & | name | ) | const
| final virtual

check if a paragraph style with a display name is already defined

Implements STOFFListener.

## ◆ isSectionOpened()

bool STOFFSpreadsheetListener::isSectionOpened | ( |  | ) | const
| inline final virtual

returns true if a section is opened

Implements STOFFListener.

## ◆ isSubDocumentOpened()

bool STOFFSpreadsheetListener::isSubDocumentOpened | ( | libstoff::SubDocumentType & | subdocType | ) | const
| final virtual

returns try if a subdocument is open

Implements STOFFListener.

## ◆ openFooter()

bool STOFFSpreadsheetListener::openFooter | ( | librevenge::RVNGPropertyList const & | extras | ) |
| final virtual

open a footer (interaction with STOFFPageSpan which fills the parameters for openFooter)

Implements STOFFListener.

## ◆ openFrame()

bool STOFFSpreadsheetListener::openFrame | ( | STOFFFrameStyle const & | frame,
|  | STOFFGraphicStyle const & | style = STOFFGraphicStyle() )
| final virtual

tries to open a frame

Implements STOFFListener.

Referenced by insertChart(), insertEquation(), insertPicture(), and insertTextBox().

## ◆ openGroup()

bool STOFFSpreadsheetListener::openGroup | ( | STOFFFrameStyle const & | frame | ) |
| final virtual

open a group (not implemented)

Implements STOFFListener.

## ◆ openHeader()

bool STOFFSpreadsheetListener::openHeader | ( | librevenge::RVNGPropertyList const & | extras | ) |
| final virtual

open a header (interaction with STOFFPageSpan which fills the parameters for openHeader)

Implements STOFFListener.

## ◆ openLink()

void STOFFSpreadsheetListener::openLink | ( | STOFFLink const & | link | ) |
| final virtual

open a link

Implements STOFFListener.

## ◆ openSection()

bool STOFFSpreadsheetListener::openSection | ( | STOFFSection const & | section | ) |
| final virtual

open a section if possible

Implements STOFFListener.

## ◆ openSheet()

void STOFFSpreadsheetListener::openSheet | ( | std::vector< float > const & | colWidth,
|  | librevenge::RVNGUnit | unit,
|  | std::vector< int > const & | repeatColWidthNumber = std::vector<int>(),
|  | librevenge::RVNGString const & | name = "" )

open a sheet

## ◆ openSheetCell()

void STOFFSpreadsheetListener::openSheetCell | ( | STOFFCell const & | cell,
|  | STOFFCellContent const & | content,
|  | int | numRepeated = 1 )

open a cell

## ◆ openSheetRow()

void STOFFSpreadsheetListener::openSheetRow | ( | float | h,
|  | librevenge::RVNGUnit | unit,
|  | int | numRepeated = 1 )

open a row with given height ( if h < 0.0, set min-row-height = -h )

## ◆ openTable()

void STOFFSpreadsheetListener::openTable | ( | STOFFTable const & | table | ) |
| final virtual

open a table

Implements STOFFListener.

## ◆ openTableCell()

void STOFFSpreadsheetListener::openTableCell | ( | STOFFCell const & | cell | ) |
| final virtual

open a cell

Implements STOFFListener.

## ◆ openTableRow()

void STOFFSpreadsheetListener::openTableRow | ( | float | h,
|  | librevenge::RVNGUnit | unit,
|  | bool | headerRow = false )
| final virtual

open a row with given height ( if h < 0.0, set min-row-height = -h )

Implements STOFFListener.

## ◆ operator=()

STOFFSpreadsheetListener & STOFFSpreadsheetListener::operator= | ( | const STOFFSpreadsheetListener & |  | ) |
| private

operator= (unimplemented)

## ◆ setDocumentLanguage()

void STOFFSpreadsheetListener::setDocumentLanguage | ( | std::string | locale | ) |
| final virtual

sets the document language

Implements STOFFListener.

## ◆ setDocumentMetaData()

void STOFFSpreadsheetListener::setDocumentMetaData | ( | const librevenge::RVNGPropertyList & | list | ) |
| final virtual

sets the document meta data

Implements STOFFListener.

## ◆ setFont()

void STOFFSpreadsheetListener::setFont | ( | STOFFFont const & | font | ) |
| final virtual

sets the font

Implements STOFFListener.

## ◆ setParagraph()

void STOFFSpreadsheetListener::setParagraph | ( | STOFFParagraph const & | paragraph | ) |
| final virtual

sets the paragraph

Implements STOFFListener.

## ◆ startDocument()

void STOFFSpreadsheetListener::startDocument | ( |  | ) |
| final virtual

starts the document

Implements STOFFListener.

Referenced by _openPageSpan().

## Member Data Documentation

## ◆ m_documentInterface

librevenge::RVNGSpreadsheetInterface* STOFFSpreadsheetListener::m_documentInterface
| protected

the document interface

Referenced by _changeList(), _closeListElement(), _closePageSpan(), _closeParagraph(), _closeSpan(), _flushDeferredTabs(), _flushText(), _openListElement(), _openPageSpan(), _openParagraph(), _openSpan(), addCoveredTableCell(), addEmptyTableCell(), closeFooter(), closeFrame(), closeHeader(), closeLink(), closeSheet(), closeSheetCell(), closeSheetRow(), closeTable(), closeTableCell(), closeTableRow(), defineStyle(), defineStyle(), defineStyle(), endDocument(), insertChart(), insertComment(), insertEOL(), insertEquation(), insertField(), insertFooterRegion(), insertHeaderRegion(), insertNote(), insertPicture(), insertShape(), insertTextBox(), openFooter(), openFrame(), openHeader(), openLink(), openSheet(), openSheetCell(), openSheetRow(), openTable(), openTableCell(), openTableRow(), and startDocument().

## ◆ m_ds

std::shared_ptr<STOFFSpreadsheetListenerInternal::DocumentState> STOFFSpreadsheetListener::m_ds
| protected

the main parse state

Referenced by _changeList(), _openPageSpan(), _startSubDocument(), closeSheet(), closeSheetRow(), defineStyle(), defineStyle(), defineStyle(), endDocument(), getPageSpan(), getSection(), handleSubDocument(), insertBreak(), insertChart(), insertEquation(), insertNote(), insertPicture(), insertShape(), insertTextBox(), isDocumentStarted(), isFontStyleDefined(), isGraphicStyleDefined(), isParagraphStyleDefined(), openFrame(), openSheet(), openSheetCell(), openSheetRow(), setDocumentLanguage(), setDocumentMetaData(), and startDocument().

## ◆ m_ps

std::shared_ptr<STOFFSpreadsheetListenerInternal::State> STOFFSpreadsheetListener::m_ps
| protected

the actual local parse state

Referenced by _changeList(), _closeListElement(), _closePageSpan(), _closeParagraph(), _closeSpan(), _endSubDocument(), _flushDeferredTabs(), _flushText(), _getListId(), _openListElement(), _openPageSpan(), _openParagraph(), _openSpan(), _popParsingState(), _pushParsingState(), _resetParagraphState(), _startSubDocument(), addCoveredTableCell(), addEmptyTableCell(), canWriteText(), closeFooter(), closeFrame(), closeHeader(), closeLink(), closeSheetCell(), closeTable(), closeTableCell(), closeTableRow(), endDocument(), getFont(), getPageSpan(), getParagraph(), handleSubDocument(), insertBreak(), insertChar(), insertChart(), insertComment(), insertEOL(), insertField(), insertFooterRegion(), insertHeaderRegion(), insertNote(), insertShape(), insertTab(), insertUnicode(), insertUnicodeString(), isHeaderFooterOpened(), isPageSpanOpened(), isParagraphOpened(), isSubDocumentOpened(), openFooter(), openFrame(), openHeader(), openLink(), openSheet(), openSheetCell(), openTable(), openTableCell(), openTableRow(), setFont(), and setParagraph().

## ◆ m_psStack

std::vector<std::shared_ptr<STOFFSpreadsheetListenerInternal::State> > STOFFSpreadsheetListener::m_psStack
| protected

stack of local state

Referenced by _popParsingState(), and _pushParsingState().

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

- STOFFSpreadsheetListener.hxx
- STOFFSpreadsheetListener.cxx