STOFFListener Class Referenceabstract

This class contains a virtual interface to all listener. More...

#include <STOFFListener.hxx>

Inheritance diagram for STOFFListener:
STOFFGraphicListener STOFFSpreadsheetListener STOFFTextListener

Public Types

enum  Type { Graphic , Presentation , Spreadsheet , Text }
 the listener type More...
 
enum  BreakType { PageBreak =0 , SoftPageBreak , ColumnBreak }
 the different break type More...
 

Public Member Functions

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

Protected Member Functions

 STOFFListener (STOFFListManagerPtr &listManager)
 constructor More...
 

Protected Attributes

STOFFListManagerPtr m_listManager
 the list manager More...
 

Detailed Description

This class contains a virtual interface to all listener.

Member Enumeration Documentation

◆ BreakType

the different break type

Enumerator
PageBreak 
SoftPageBreak 
ColumnBreak 

◆ Type

the listener type

Enumerator
Graphic 
Presentation 
Spreadsheet 
Text 

Constructor & Destructor Documentation

◆ ~STOFFListener()

STOFFListener::~STOFFListener ( )
virtual

destructor

◆ STOFFListener()

STOFFListener::STOFFListener ( STOFFListManagerPtr listManager)
explicitprotected

constructor

Member Function Documentation

◆ addCoveredTableCell()

virtual void STOFFListener::addCoveredTableCell ( STOFFVec2i const &  pos)
pure virtual

add covered cell

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ addEmptyTableCell()

virtual void STOFFListener::addEmptyTableCell ( STOFFVec2i const &  pos,
STOFFVec2i  span = STOFFVec2i(1, 1) 
)
pure virtual

add empty cell

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ canOpenSectionAddBreak()

virtual bool STOFFListener::canOpenSectionAddBreak ( ) const
pure virtual

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

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ canWriteText()

virtual bool STOFFListener::canWriteText ( ) const
pure virtual

returns true if we can add text data

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

Referenced by insertUnicodeList().

◆ closeFooter()

virtual bool STOFFListener::closeFooter ( )
pure virtual

◆ closeFrame()

virtual void STOFFListener::closeFrame ( )
pure virtual

low level: tries to close the last opened frame

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ closeGroup()

virtual void STOFFListener::closeGroup ( )
pure virtual

low level: tries to close the last opened group

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ closeHeader()

virtual bool STOFFListener::closeHeader ( )
pure virtual

◆ closeLink()

virtual void STOFFListener::closeLink ( )
pure virtual

◆ closeSection()

virtual bool STOFFListener::closeSection ( )
pure virtual

close a section

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ closeTable()

virtual void STOFFListener::closeTable ( )
pure virtual

closes this table

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ closeTableCell()

virtual void STOFFListener::closeTableCell ( )
pure virtual

◆ closeTableRow()

virtual void STOFFListener::closeTableRow ( )
pure virtual

closes this row

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ defineStyle() [1/3]

virtual void STOFFListener::defineStyle ( STOFFFont const &  style)
pure virtual

defines a font styles

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ defineStyle() [2/3]

virtual void STOFFListener::defineStyle ( STOFFGraphicStyle const &  style)
pure virtual

defines a graphic styles

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ defineStyle() [3/3]

virtual void STOFFListener::defineStyle ( STOFFParagraph const &  style)
pure virtual

defines a paragraph styles

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ endDocument()

virtual void STOFFListener::endDocument ( bool  sendDelayedSubDoc = true)
pure virtual

ends the document

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ getFont()

virtual STOFFFont const& STOFFListener::getFont ( ) const
pure virtual

returns the actual font

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ getListManager()

STOFFListManagerPtr STOFFListener::getListManager ( ) const
inline

return the list manager

◆ getPageSpan()

virtual STOFFPageSpan const& STOFFListener::getPageSpan ( )
pure virtual

returns the current page span

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

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ getParagraph()

virtual STOFFParagraph const& STOFFListener::getParagraph ( ) const
pure virtual

returns the actual paragraph

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ getSection()

virtual STOFFSection const& STOFFListener::getSection ( ) const
pure virtual

returns the actual section

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ getType()

virtual Type STOFFListener::getType ( ) const
pure virtual

returns the listener type

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ handleSubDocument()

virtual void STOFFListener::handleSubDocument ( STOFFSubDocumentPtr  subDocument,
libstoff::SubDocumentType  subDocumentType 
)
pure virtual

low level: function called to add a subdocument

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ insertBreak()

virtual void STOFFListener::insertBreak ( BreakType  breakType)
pure virtual

inserts a break type: ColumBreak, PageBreak, ..

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ insertChar()

virtual void STOFFListener::insertChar ( uint8_t  character)
pure virtual

adds a basic character, ..

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ insertComment()

virtual void STOFFListener::insertComment ( STOFFSubDocumentPtr subDocument,
librevenge::RVNGString const &  creator = "",
librevenge::RVNGString const &  date = "" 
)
pure virtual

◆ insertEOL()

virtual void STOFFListener::insertEOL ( bool  softBreak = false)
pure virtual

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

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

Referenced by insertUnicodeList().

◆ insertEquation()

virtual void STOFFListener::insertEquation ( STOFFFrameStyle const &  frame,
librevenge::RVNGString const &  equation,
STOFFGraphicStyle const &  style = STOFFGraphicStyle() 
)
pure virtual

adds a equation given a position

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ insertField()

virtual void STOFFListener::insertField ( STOFFField const &  field)
pure virtual

adds a field type

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ insertFooterRegion()

virtual bool STOFFListener::insertFooterRegion ( STOFFSubDocumentPtr  subDocument,
librevenge::RVNGString const &  which 
)
pure virtual

insert a footer

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

Referenced by STOFFHeaderFooter::send().

◆ insertHeaderRegion()

virtual bool STOFFListener::insertHeaderRegion ( STOFFSubDocumentPtr  subDocument,
librevenge::RVNGString const &  which 
)
pure virtual

insert a header

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

Referenced by STOFFHeaderFooter::send().

◆ insertNote()

virtual void STOFFListener::insertNote ( STOFFNote const &  note,
STOFFSubDocumentPtr subDocument 
)
pure virtual

◆ insertPicture()

virtual void STOFFListener::insertPicture ( STOFFFrameStyle const &  frame,
STOFFEmbeddedObject const &  picture,
STOFFGraphicStyle const &  style = STOFFGraphicStyle() 
)
pure virtual

adds a picture with various representationin given position.

Note
by default only send the first picture

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ insertShape()

virtual void STOFFListener::insertShape ( STOFFFrameStyle const &  frame,
STOFFGraphicShape const &  shape,
STOFFGraphicStyle const &  style 
)
pure virtual

adds a shape picture in given position

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ insertTab()

virtual void STOFFListener::insertTab ( )
pure virtual

◆ insertTextBox()

virtual void STOFFListener::insertTextBox ( STOFFFrameStyle const &  frame,
STOFFSubDocumentPtr  subDocument,
STOFFGraphicStyle const &  frameStyle = STOFFGraphicStyle() 
)
pure virtual

adds a textbox in given position

Implemented in STOFFTextListener, STOFFGraphicListener, and STOFFSpreadsheetListener.

◆ insertUnicode()

virtual void STOFFListener::insertUnicode ( uint32_t  character)
pure virtual

adds an unicode character.

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

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

Referenced by insertUnicodeList().

◆ insertUnicodeList()

void STOFFListener::insertUnicodeList ( std::vector< uint32_t > const &  list)
inline

try to insert a list of unicode character

◆ insertUnicodeString()

virtual void STOFFListener::insertUnicodeString ( librevenge::RVNGString const &  str)
pure virtual

adds a unicode string

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ isDocumentStarted()

virtual bool STOFFListener::isDocumentStarted ( ) const
pure virtual

returns true if a document is opened

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ isFontStyleDefined()

virtual bool STOFFListener::isFontStyleDefined ( librevenge::RVNGString const &  name) const
pure virtual

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

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ isGraphicStyleDefined()

virtual bool STOFFListener::isGraphicStyleDefined ( librevenge::RVNGString const &  name) const
pure virtual

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

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ isHeaderFooterOpened()

virtual bool STOFFListener::isHeaderFooterOpened ( ) const
pure virtual

returns true if the header/footer is open

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ isPageSpanOpened()

virtual bool STOFFListener::isPageSpanOpened ( ) const
pure virtual

returns true if a page is opened

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ isParagraphOpened()

virtual bool STOFFListener::isParagraphOpened ( ) const
pure virtual

returns true if a paragraph or a list is opened

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ isParagraphStyleDefined()

virtual bool STOFFListener::isParagraphStyleDefined ( librevenge::RVNGString const &  name) const
pure virtual

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

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ isSectionOpened()

virtual bool STOFFListener::isSectionOpened ( ) const
pure virtual

returns true if a section is opened

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ isSubDocumentOpened()

virtual bool STOFFListener::isSubDocumentOpened ( libstoff::SubDocumentType subdocType) const
pure virtual

returns true if a subdocument is open

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ openFooter()

virtual bool STOFFListener::openFooter ( librevenge::RVNGPropertyList const &  extras)
pure virtual

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

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

Referenced by STOFFPageSpan::sendHeaderFooters().

◆ openFrame()

virtual bool STOFFListener::openFrame ( STOFFFrameStyle const &  frame,
STOFFGraphicStyle const &  style = STOFFGraphicStyle() 
)
pure virtual

low level: tries to open a frame

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ openGroup()

virtual bool STOFFListener::openGroup ( STOFFFrameStyle const &  frame)
pure virtual

low level: tries to open a group

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ openHeader()

virtual bool STOFFListener::openHeader ( librevenge::RVNGPropertyList const &  extras)
pure virtual

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

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

Referenced by STOFFPageSpan::sendHeaderFooters().

◆ openLink()

virtual void STOFFListener::openLink ( STOFFLink const &  link)
pure virtual

◆ openSection()

virtual bool STOFFListener::openSection ( STOFFSection const &  section)
pure virtual

open a section if possible

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ openTable()

virtual void STOFFListener::openTable ( STOFFTable const &  table)
pure virtual

◆ openTableCell()

virtual void STOFFListener::openTableCell ( STOFFCell const &  cell)
pure virtual

◆ openTableRow()

virtual void STOFFListener::openTableRow ( float  h,
librevenge::RVNGUnit  unit,
bool  headerRow = false 
)
pure virtual

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

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ setDocumentLanguage()

virtual void STOFFListener::setDocumentLanguage ( std::string  locale)
pure virtual

sets the documents language

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ setDocumentMetaData()

virtual void STOFFListener::setDocumentMetaData ( const librevenge::RVNGPropertyList &  list)
pure virtual

sets the document meta data

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ setFont()

virtual void STOFFListener::setFont ( STOFFFont const &  font)
pure virtual

◆ setParagraph()

virtual void STOFFListener::setParagraph ( STOFFParagraph const &  paragraph)
pure virtual

sets the paragraph

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

◆ startDocument()

virtual void STOFFListener::startDocument ( )
pure virtual

starts the document

Implemented in STOFFTextListener, STOFFSpreadsheetListener, and STOFFGraphicListener.

Member Data Documentation

◆ m_listManager


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

Generated on Wed Mar 15 2023 00:00:00 for libstaroffice by doxygen 1.9.1