Mako 7.4.0 API
Loading...
Searching...
No Matches
JawsMako::IOutputWriter Class Referenceabstract

A writer for writing individual pages and documents to an output in piecemeal fashion. More...

#include <jawsmako.h>

Inheritance diagram for JawsMako::IOutputWriter:

Public Member Functions

virtual void beginDocument (const IDocumentPtr &document)=0
 Begin a document. This document need not be completely populated with pages.
 
virtual void endDocument ()=0
 Finish a document.
 
virtual void writePage (const IPagePtr &page)=0
 Write a page to the output.
 
virtual void finish ()=0
 Finish output and flush the results.
 
- Public Member Functions inherited from IRCObject
virtual void addRef () const =0
 Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
 
virtual bool decRef () const =0
 Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
 
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to.
 

Additional Inherited Members

- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

A writer for writing individual pages and documents to an output in piecemeal fashion.

Member Function Documentation

◆ beginDocument()

virtual void JawsMako::IOutputWriter::beginDocument ( const IDocumentPtr & document)
pure virtual

Begin a document. This document need not be completely populated with pages.

      Once this has been invoked, pages may be written using writePage().

◆ writePage()

virtual void JawsMako::IOutputWriter::writePage ( const IPagePtr & page)
pure virtual

Write a page to the output.

      beginDocument() must have been called to begin the document before any pages
      may be written. The page may be discarded after this is called.
Parameters
pageThe page to write.

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