oofRepRTFEnv Class Reference
[RTF Report rendering.]

#include <oofrpRTF.h>

Inheritance diagram for oofRepRTFEnv:

[legend]Collaboration diagram for oofRepRTFEnv:

[legend]List of all members.

---

Detailed Description

Specify output to MS Word-compatible Rich Text stream.

Provides encoding services for strings and oofPict's.

Public Types
enum	{ eRenderType = 'RTF ' }
Public Member Functions
	oofRepRTFEnv ()
	oofRepRTFEnv (std::ostream &)
	oofRepRTFEnv (const char *fileName)
virtual void	changeTextStyle (oofRepTextStyle *)
virtual unsigned short	heightOfTextStyle (oofRepTextStyle *)
virtual void	drawPageBreak ()
virtual void	startSection ()
	called before each section, regardless of settings unlike drawSectionBreak which may not be called if no page breaks specified
virtual unsigned long	calcPageHeight ()
virtual unsigned long	calcPageWidth ()
virtual void	startEnvironment ()
	Setup the start of document including font, color, stylesheet and page dimensions.
virtual void	endEnvironment ()
virtual bool	preprocessesPageHeadersAndFooters () const
virtual void	makeRenderDispatch (oofRepDrawable *) const
virtual void	makeRenderDispatch (oofAdorner *) const
virtual oofRepRenderT	renderType () const
virtual bool	canDraw ()
	Confirm can draw to stream - only used for GUI to choose destination.
virtual void	drawSectionBreak ()
virtual bool	isPrintingEnvironment () const
virtual void	makeRender ()
virtual void	drawPageBorder (long top, long left, long bottom, long right)
virtual void	splitBandOverPage ()
virtual void	resumeBandOverPage ()
Static Public Member Functions
void	encodeToRTFStream (std::ostream &, const char *)
void	encodeToRTFStream (std::ostream &os, oofPict *, int widthPixels, int heightPixels)
	Write as Mac Pict or Windows Bitmap.
oofString	encodeRTFString (const oofString &)
void	writeWrappedRTFasHexData (std::ostream &os, const char *inBuf, const unsigned int inBufLen)
	Helper function for encodeToRTFStream.
bool	exportingBitmapsNotMetafiles ()
std::ostream &	out ()
Static Public Attributes
bool	sExportBitmapsNotMetafiles = true
	Due to major import problems with Metafiles in RTF, have default true on this flag.
std::ostream *	sOut = 0
Protected Attributes
int	mSectionNumber
std::ostream *	mOut
std::ofstream *	mOwnedofstream

---

Member Enumeration Documentation

anonymous enum

Enumeration values: eRenderType

---

Constructor & Destructor Documentation

oofRepRTFEnv::oofRepRTFEnv (   )

oofRepRTFEnv::oofRepRTFEnv (  std::ostream &   )

oofRepRTFEnv::oofRepRTFEnv (  const char *  fileName  )

---

Member Function Documentation

unsigned long oofRepRTFEnv::calcPageHeight (   )  [virtual]

Implements oofRepEnvironment.

unsigned long oofRepRTFEnv::calcPageWidth (   )  [virtual]

Implements oofRepEnvironment.

bool oofRepStreamEnv::canDraw (   )  [virtual, inherited]

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.

void oofRepRTFEnv::changeTextStyle (  oofRepTextStyle *   )  [virtual]

Implements oofRepEnvironment.

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

Reimplemented in oofRepWinGUIPreviewMFC, and oofRepMacEnv.

void oofRepRTFEnv::drawPageBreak (   )  [virtual]

Implements oofRepEnvironment.

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

oofString oofRepRTFEnv::encodeRTFString (  const oofString &  srcString  )  [static]

Todo: combine redundant encoding here and encodeToRTFStream. You can tell this class was written by a junior programmer!

void oofRepRTFEnv::encodeToRTFStream (  std::ostream &  os, oofPict *  inPict, int  inWidthPixels, int  inHeightPixels )  [static]

Write as Mac Pict or Windows Bitmap. Warning: old code included that tries to write Metafile but very unreliable. Todo: decide if will allow user to specify range of metafile types as well.

void oofRepRTFEnv::encodeToRTFStream (  std::ostream &  , const char *  )  [static]

void oofRepRTFEnv::endEnvironment (   )  [virtual]

Reimplemented from oofRepEnvironment.

bool oofRepRTFEnv::exportingBitmapsNotMetafiles (   )  [inline, static]

unsigned short oofRepRTFEnv::heightOfTextStyle (  oofRepTextStyle *   )  [virtual]

Implements oofRepEnvironment.

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

Reimplemented in oofMacCarbonPrint, oofRepWinPrint, and oofRepMacPrint.

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

void oofRepRTFEnv::makeRenderDispatch (  oofAdorner *   )  const [virtual]

Implements oofRepEnvironment.

void oofRepRTFEnv::makeRenderDispatch (  oofRepDrawable *   )  const [virtual]

Implements oofRepEnvironment.

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

bool oofRepRTFEnv::preprocessesPageHeadersAndFooters (   )  const [virtual]

Reimplemented from oofRepEnvironment.

oofRepRenderT oofRepRTFEnv::renderType (   )  const [virtual]

Implements oofRepEnvironment.

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

Reimplemented in oofRepEditingEnv.

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

Reimplemented in oofRepEditingEnv.

void oofRepRTFEnv::startEnvironment (   )  [virtual]

Setup the start of document including font, color, stylesheet and page dimensions. Todo: write out font table of all fonts used in all report objects. write out multiple styles for styles used in all report objects. Reimplemented from oofRepEnvironment.

void oofRepRTFEnv::startSection (   )  [virtual]

called before each section, regardless of settings unlike drawSectionBreak which may not be called if no page breaks specified Reimplemented from oofRepEnvironment.

void oofRepRTFEnv::writeWrappedRTFasHexData (  std::ostream &  os, const char *  inBuf, const unsigned int  inBufLen )  [static]

Helper function for encodeToRTFStream.

---

Member Data Documentation

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

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

int oofRepRTFEnv::mSectionNumber [protected]

bool oofRepRTFEnv::sExportBitmapsNotMetafiles = true [static]

Due to major import problems with Metafiles in RTF, have default true on this flag.

ostream * oofRepStreamEnv::sOut = 0 [static, inherited]

---

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

• oofrpRTF.h
• oofrpRTF.cpp

---