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