MWAWListener Class Referenceabstract

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

#include <MWAWListener.hxx>

Inheritance diagram for MWAWListener:
MWAWContentListener MWAWGraphicListener

Public Types

enum  BreakType { PageBreak =0, SoftPageBreak, ColumnBreak }
 the different break type More...
 

Public Member Functions

virtual ~MWAWListener ()
 
virtual bool isDocumentStarted () const =0
 returns true if a document is opened More...
 
virtual bool canWriteText () const =0
 returns true if we can add text data More...
 
virtual bool isSubDocumentOpened (libmwaw::SubDocumentType &subdocType) const =0
 returns true if a subdocument is open More...
 
virtual void insertChar (uint8_t character)=0
 adds a basic character, .. More...
 
virtual void insertCharacter (unsigned char c)=0
 insert a character using the font converter to find the utf8 character More...
 
virtual int insertCharacter (unsigned char c, MWAWInputStreamPtr &input, long endPos=-1)=0
 insert a character using the font converter to find the utf8 character and if needed, input to read extra character. More...
 
virtual void insertUnicode (uint32_t character)=0
 adds an unicode character. More...
 
virtual void insertUnicodeString (WPXString 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 (MWAWFont const &font)=0
 sets the font More...
 
virtual MWAWFont 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 (MWAWParagraph const &paragraph)=0
 sets the paragraph More...
 
virtual MWAWParagraph const & getParagraph () const =0
 returns the actual paragraph More...
 
virtual void insertField (MWAWField const &field)=0
 adds a field type 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 MWAWSection const & getSection () const =0
 returns the actual section More...
 
virtual bool openSection (MWAWSection 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...
 

Detailed Description

This class contains a virtual interface to all listener.

Note
actually contains mainly code for adding text

Member Enumeration Documentation

the different break type

Enumerator
PageBreak 
SoftPageBreak 
ColumnBreak 

Constructor & Destructor Documentation

virtual MWAWListener::~MWAWListener ( )
inlinevirtual

Member Function Documentation

virtual bool MWAWListener::canOpenSectionAddBreak ( ) const
pure virtual

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

Implemented in MWAWContentListener, and MWAWGraphicListener.

virtual bool MWAWListener::canWriteText ( ) const
pure virtual

returns true if we can add text data

Implemented in MWAWGraphicListener, and MWAWContentListener.

virtual bool MWAWListener::closeSection ( )
pure virtual

close a section

Implemented in MWAWContentListener, and MWAWGraphicListener.

virtual MWAWFont const& MWAWListener::getFont ( ) const
pure virtual

returns the actual font

Implemented in MWAWContentListener, and MWAWGraphicListener.

virtual MWAWParagraph const& MWAWListener::getParagraph ( ) const
pure virtual

returns the actual paragraph

Implemented in MWAWContentListener, and MWAWGraphicListener.

virtual MWAWSection const& MWAWListener::getSection ( ) const
pure virtual

returns the actual section

Implemented in MWAWContentListener, and MWAWGraphicListener.

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

inserts a break type: ColumBreak, PageBreak, ..

Implemented in MWAWContentListener, and MWAWGraphicListener.

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

adds a basic character, ..

Implemented in MWAWContentListener, and MWAWGraphicListener.

virtual void MWAWListener::insertCharacter ( unsigned char  c)
pure virtual

insert a character using the font converter to find the utf8 character

Implemented in MWAWContentListener, and MWAWGraphicListener.

virtual int MWAWListener::insertCharacter ( unsigned char  c,
MWAWInputStreamPtr input,
long  endPos = -1 
)
pure virtual

insert a character using the font converter to find the utf8 character and if needed, input to read extra character.

Returns
the number of extra character read

Implemented in MWAWContentListener, and MWAWGraphicListener.

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

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

Implemented in MWAWContentListener, and MWAWGraphicListener.

virtual void MWAWListener::insertField ( MWAWField const &  field)
pure virtual

adds a field type

Implemented in MWAWContentListener, and MWAWGraphicListener.

Referenced by GWTextInternal::Token::sendTo().

virtual void MWAWListener::insertTab ( )
pure virtual

adds a tab

Implemented in MWAWContentListener, and MWAWGraphicListener.

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

adds an unicode character.

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

Implemented in MWAWContentListener, and MWAWGraphicListener.

virtual void MWAWListener::insertUnicodeString ( WPXString const &  str)
pure virtual

adds a unicode string

Implemented in MWAWContentListener, and MWAWGraphicListener.

Referenced by GWTextInternal::Token::sendTo().

virtual bool MWAWListener::isDocumentStarted ( ) const
pure virtual

returns true if a document is opened

Implemented in MWAWContentListener, and MWAWGraphicListener.

virtual bool MWAWListener::isParagraphOpened ( ) const
pure virtual

returns true if a paragraph or a list is opened

Implemented in MWAWContentListener, and MWAWGraphicListener.

virtual bool MWAWListener::isSectionOpened ( ) const
pure virtual

returns true if a section is opened

Implemented in MWAWContentListener, and MWAWGraphicListener.

virtual bool MWAWListener::isSubDocumentOpened ( libmwaw::SubDocumentType subdocType) const
pure virtual

returns true if a subdocument is open

Implemented in MWAWContentListener, and MWAWGraphicListener.

virtual bool MWAWListener::openSection ( MWAWSection const &  section)
pure virtual

open a section if possible

Implemented in MWAWContentListener, and MWAWGraphicListener.

virtual void MWAWListener::setFont ( MWAWFont const &  font)
pure virtual

sets the font

Implemented in MWAWContentListener, and MWAWGraphicListener.

virtual void MWAWListener::setParagraph ( MWAWParagraph const &  paragraph)
pure virtual

sets the paragraph

Implemented in MWAWContentListener, and MWAWGraphicListener.

Referenced by CWText::setProperty().


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

Generated on Tue Mar 10 2015 17:32:10 for libmwaw by doxygen 1.8.5