OOFILE  1.9
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
oofRepStreamEnv Class Referenceabstract

Base environment for rendering to a text stream. More...

#include <oofrep.h>

Inheritance diagram for oofRepStreamEnv:
Inheritance graph
[legend]
Collaboration diagram for oofRepStreamEnv:
Collaboration graph
[legend]

Public Member Functions

virtual unsigned long calcPageHeight ()=0
 
virtual unsigned long calcPageWidth ()=0
 
virtual bool canDraw ()
 Confirm can draw to stream - only used for GUI to choose destination. More...
 
virtual void changeTextStyle (oofRepTextStyle *)=0
 
virtual void drawPageBorder (long top, long left, long bottom, long right)
 
virtual void drawPageBreak ()=0
 
virtual void drawSectionBreak ()
 
virtual void endEnvironment ()
 
virtual unsigned short heightOfTextStyle (oofRepTextStyle *)=0
 
virtual bool isPrintingEnvironment () const
 
virtual void makeRender ()
 
virtual void makeRenderDispatch (oofRepDrawable *) const =0
 
virtual void makeRenderDispatch (oofAdorner *) const =0
 
 oofRepStreamEnv ()
 
 oofRepStreamEnv (std::ostream &)
 
 oofRepStreamEnv (const char *fileName, bool openBinary=false)
 
virtual bool preprocessesPageHeadersAndFooters () const
 
virtual oofRepRenderT renderType () const =0
 
virtual void resumeBandOverPage ()
 
virtual void splitBandOverPage ()
 
virtual void startEnvironment ()
 
virtual void startSection ()
 
virtual ~oofRepStreamEnv ()
 

Static Public Member Functions

static std::ostream & out ()
 

Static Public Attributes

static std::ostream * sOut = 0
 

Protected Attributes

std::ostream * mOut
 
std::ofstream * mOwnedofstream
 

Detailed Description

Base environment for rendering to a text stream.

Used when exporting reports to file or by HTTP servers.

Warning
Not Thread Safe - has static stream sOut so can only run one report at once through oofRep::draw. This is not a problem as oofRep itself is not thread safe whilst drawing due to the

Definition at line 446 of file oofrep.h.

Constructor & Destructor Documentation

oofRepStreamEnv::oofRepStreamEnv ( )

Definition at line 1282 of file oofrep2.cpp.

oofRepStreamEnv::oofRepStreamEnv ( std::ostream &  )
oofRepStreamEnv::oofRepStreamEnv ( const char *  fileName,
bool  openBinary = false 
)

Definition at line 1296 of file oofrep2.cpp.

References mOut, and mOwnedofstream.

oofRepStreamEnv::~oofRepStreamEnv ( )
virtual

Definition at line 1308 of file oofrep2.cpp.

References mOwnedofstream.

Member Function Documentation

virtual unsigned long oofRepEnvironment::calcPageHeight ( )
pure virtualinherited
virtual unsigned long oofRepEnvironment::calcPageWidth ( )
pure virtualinherited
bool oofRepStreamEnv::canDraw ( )
virtual

Confirm can draw to stream - only used for GUI to choose destination.

Todo:

check why there's only a Mac file dialog here - do we use under Win?

add exception for NavGetDefaultDialogOptions failing.

Reimplemented from oofRepEnvironment.

Definition at line 1323 of file oofrep2.cpp.

References oofDirectory::gotoDirectory(), mOut, and sOut.

virtual void oofRepEnvironment::changeTextStyle ( oofRepTextStyle )
pure virtualinherited
void oofRepEnvironment::drawPageBorder ( long  top,
long  left,
long  bottom,
long  right 
)
virtualinherited

Reimplemented in oofRepMacEnv, and oofRepWinGUIPreviewMFC.

Definition at line 1266 of file oofrep2.cpp.

Referenced by oofRep::drawFirstPageHeaders(), and oofRep::drawPageHeaders().

virtual void oofRepEnvironment::drawPageBreak ( )
pure virtualinherited
void oofRepEnvironment::drawSectionBreak ( )
virtualinherited

Definition at line 1273 of file oofrep2.cpp.

References oofRepEnvironment::drawPageBreak().

Referenced by oofRepSection::drawSection().

void oofRepEnvironment::endEnvironment ( )
virtualinherited
virtual unsigned short oofRepEnvironment::heightOfTextStyle ( oofRepTextStyle )
pure virtualinherited
bool oofRepEnvironment::isPrintingEnvironment ( ) const
virtualinherited
virtual void oofRepEnvironment::makeRender ( )
inlinevirtualinherited

Definition at line 420 of file oofrep.h.

Referenced by oofRep::draw(), and oofRepMulti::draw().

virtual void oofRepEnvironment::makeRenderDispatch ( oofRepDrawable ) const
pure virtualinherited
virtual void oofRepEnvironment::makeRenderDispatch ( oofAdorner ) const
pure virtualinherited
std::ostream & oofRepStreamEnv::out ( )
inlinestatic

Definition at line 2727 of file oofrep.h.

References sOut.

Referenced by oofRepSpaceBand_XMLRender::describeLayout(), oofRepGraphBand_XMLRender::describeLayout(), oofRepLineBand_XMLRender::describeLayout(), oofRepTextBlock_XMLRender::describeLayout(), oofRepPageNoBlock_XMLRender::describeLayout(), oofRepSpaceBand_HTMLRender::draw(), oofRepGraphBand_CSVRender::draw(), oofRepGraphBand_TSVRender::draw(), oofRepLayoutBand_HTMLRender::draw(), oofRepLayoutBand_CSVRender::draw(), oofRepLayoutBand_TSVRender::draw(), oofRepFreeImageBand_RTFRender::draw(), oofRepLineBand_HTMLRender::draw(), oofRepPictBand_HTMLRender::draw(), oofRepViewBand_HTMLRender::draw(), oofRepViewBand_CSVRender::draw(), oofRepGraphBand_XMLRender::draw(), oofRepViewBand_TSVRender::draw(), oofRepTextBlock_CSVRender::draw(), oofRepTextBlock_TSVRender::draw(), oofRepTextBlock_HTMLRender::draw(), oofRepSpaceBand_RTFRender::draw(), oofRepPictBlock_HTMLRender::draw(), oofRepGraphBand_RTFRender::draw(), oofRepLayoutBand_RTFRender::draw(), oofRepLineBand_RTFRender::draw(), oofRepPictBand_RTFRender::draw(), oofRepViewBand_RTFRender::draw(), oofRepTextBlock_RTFRender::draw(), oofRepPictBlock_RTFRender::draw(), oofRepPageNoBlock_RTFRender::draw(), oofRepViewBand_CSVRender::drawColumnHeaders(), oofRepViewBand_TSVRender::drawColumnHeaders(), oofRepViewBand_RTFRender::drawColumnHeaders(), oofRepRTFEnv::encodeToRTFStream(), oofRepRTFEnv::endEnvironment(), oofRepViewBand_HTMLRender::endTableBody(), oofRepViewBand_XMLRender::oofRepViewBand_XMLRender(), oofRepRTFEnv::startEnvironment(), oofRepXMLEnv::StartReport(), oofRepViewBand_HTMLRender::startTableBody(), OOF_repXMLadornerVisitor::VisitAdorner(), OOF_repXMLlayoutVisitor::VisitBandFooterBreaks(), OOF_repXMLlayoutVisitor::VisitBandFooters(), OOF_repXMLlayoutVisitor::VisitBandHeaderBreaks(), OOF_repXMLlayoutVisitor::VisitBandHeaders(), OOF_repXMLlayoutVisitor::VisitBreakList(), OOF_repXMLschemaVisitor::VisitComplexBand(), OOF_repXMLlayoutVisitor::VisitComplexBand(), OOF_repXMLstyleVisitor::VisitDrawable(), OOF_repXMLlayoutVisitor::VisitFirstPageFooters(), OOF_repXMLlayoutVisitor::VisitFirstPageHeaders(), OOF_repXMLlayoutVisitor::VisitLayoutBand(), OOF_repXMLschemaVisitor::VisitView(), and OOF_repXMLlayoutVisitor::WriteColumns().

bool oofRepEnvironment::preprocessesPageHeadersAndFooters ( ) const
virtualinherited
virtual oofRepRenderT oofRepEnvironment::renderType ( ) const
pure virtualinherited
virtual void oofRepEnvironment::resumeBandOverPage ( )
inlinevirtualinherited
virtual void oofRepEnvironment::splitBandOverPage ( )
inlinevirtualinherited
void oofRepEnvironment::startEnvironment ( )
virtualinherited
void oofRepEnvironment::startSection ( )
virtualinherited

Reimplemented in oofRepXMLEnv, and oofRepRTFEnv.

Definition at line 1253 of file oofrep2.cpp.

Referenced by oofRepSection::drawSection().

Member Data Documentation

std::ostream* oofRepStreamEnv::mOut
protected
std::ofstream* oofRepStreamEnv::mOwnedofstream
protected

Definition at line 458 of file oofrep.h.

Referenced by oofRepStreamEnv(), and ~oofRepStreamEnv().

ostream * oofRepStreamEnv::sOut = 0
static

Definition at line 462 of file oofrep.h.

Referenced by canDraw(), and out().


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