oofRepStreamEnv Class Reference
[OOFILE Report writer]

#include <oofrep.h>

Inheritance diagram for oofRepStreamEnv:

[legend]Collaboration diagram for oofRepStreamEnv:

[legend]List of all members.

---

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

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

---

Constructor & Destructor Documentation

oofRepStreamEnv::oofRepStreamEnv (   )

oofRepStreamEnv::oofRepStreamEnv (  std::ostream &   )

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

oofRepStreamEnv::~oofRepStreamEnv (   )  [virtual]

---

Member Function Documentation

virtual unsigned long oofRepEnvironment::calcPageHeight (   )  [pure virtual, inherited]

Implemented in oofMacCarbonPrint, oofRepWinGUIPreviewMFC, oofRepMacPrint, oofRepMacGUIPreviewPP, oofRepCSVEnv, oofRepHTMLEnv, oofRepRTFEnv, oofRepTSVEnv, and oofRepXMLEnv.

virtual unsigned long oofRepEnvironment::calcPageWidth (   )  [pure virtual, inherited]

Implemented in oofMacCarbonPrint, oofRepWinGUIPreviewMFC, oofRepMacPrint, oofRepMacGUIPreviewPP, oofRepCSVEnv, oofRepHTMLEnv, oofRepRTFEnv, oofRepTSVEnv, and oofRepXMLEnv.

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.

virtual void oofRepEnvironment::changeTextStyle (  oofRepTextStyle *   )  [pure virtual, inherited]

Implemented in oofMacCarbonPrint, oofRepWinGUIPreviewMFC, oofRepMacPrint, oofRepMacGUIPreviewPP, oofRepCSVEnv, oofRepHTMLEnv, oofRepRTFEnv, oofRepTSVEnv, and oofRepXMLEnv.

void oofRepEnvironment::drawPageBorder (  long  top, long  left, long  bottom, long  right )  [virtual, inherited]

Reimplemented in oofRepWinGUIPreviewMFC, and oofRepMacEnv.

virtual void oofRepEnvironment::drawPageBreak (   )  [pure virtual, inherited]

Implemented in oofMacCarbonPrint, oofRepWinGUIPreviewMFC, oofRepEditingEnv, oofRepMacPrint, oofRepMacGUIPreviewPP, oofRepCSVEnv, oofRepHTMLEnv, oofRepRTFEnv, oofRepTSVEnv, and oofRepXMLEnv.

void oofRepEnvironment::drawSectionBreak (   )  [virtual, inherited]

void oofRepEnvironment::endEnvironment (   )  [virtual, inherited]

Reimplemented in oofMacCarbonPrint, oofRepEditingEnv, oofRepMacPrint, oofRepMacGUIPreviewPP, oofRepCSVEnv, oofRepHTMLEnv, oofRepRTFEnv, oofRepTSVEnv, and oofRepXMLEnv.

virtual unsigned short oofRepEnvironment::heightOfTextStyle (  oofRepTextStyle *   )  [pure virtual, inherited]

Implemented in oofMacCarbonPrint, oofRepMacPrint, oofRepMacGUIPreviewPP, oofRepCSVEnv, oofRepHTMLEnv, oofRepRTFEnv, oofRepTSVEnv, oofRepWinEnv, and oofRepXMLEnv.

bool oofRepEnvironment::isPrintingEnvironment (   )  const [virtual, inherited]

Reimplemented in oofMacCarbonPrint, oofRepWinPrint, and oofRepMacPrint.

virtual void oofRepEnvironment::makeRender (   )  [inline, virtual, inherited]

virtual void oofRepEnvironment::makeRenderDispatch (  oofAdorner *   )  const [pure virtual, inherited]

Implemented in oofRepEditingEnv, oofRepMacEnv, oofRepCSVEnv, oofRepHTMLEnv, oofRepRTFEnv, oofRepTSVEnv, oofRepTextEnv, oofRepWinEnv, and oofRepXMLEnv.

virtual void oofRepEnvironment::makeRenderDispatch (  oofRepDrawable *   )  const [pure virtual, inherited]

Implemented in oofRepEditingEnv, oofRepMacEnv, oofRepCSVEnv, oofRepHTMLEnv, oofRepRTFEnv, oofRepTSVEnv, oofRepTextEnv, oofRepWinEnv, and oofRepXMLEnv.

std::ostream & oofRepStreamEnv::out (   )  [inline, static]

bool oofRepEnvironment::preprocessesPageHeadersAndFooters (   )  const [virtual, inherited]

Reimplemented in oofRepCSVEnv, oofRepRTFEnv, oofRepTSVEnv, and oofRepXMLEnv.

virtual oofRepRenderT oofRepEnvironment::renderType (   )  const [pure virtual, inherited]

Implemented in oofRepMacEnv, oofRepCSVEnv, oofRepHTMLEnv, oofRepRTFEnv, oofRepTSVEnv, oofRepTextEnv, oofRepWinEnv, and oofRepXMLEnv.

virtual void oofRepEnvironment::resumeBandOverPage (   )  [inline, virtual, inherited]

Reimplemented in oofRepEditingEnv.

virtual void oofRepEnvironment::splitBandOverPage (   )  [inline, virtual, inherited]

Reimplemented in oofRepEditingEnv.

void oofRepEnvironment::startEnvironment (   )  [virtual, inherited]

Reimplemented in oofMacCarbonPrint, oofRepEditingEnv, oofRepMacPrint, oofRepMacGUIPreviewPP, oofRepCSVEnv, oofRepHTMLEnv, oofRepRTFEnv, oofRepTSVEnv, oofRepWinEnv, and oofRepXMLEnv.

void oofRepEnvironment::startSection (   )  [virtual, inherited]

Reimplemented in oofRepRTFEnv, and oofRepXMLEnv.

---

Member Data Documentation

std::ostream* oofRepStreamEnv::mOut [protected]

std::ofstream* oofRepStreamEnv::mOwnedofstream [protected]

ostream * oofRepStreamEnv::sOut = 0 [static]

---

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

• oofrep.h
• oofrep2.cpp

---