oofRepBlock Class Reference
[OOFILE Report writer]

#include <oofrep.h>

Inheritance diagram for oofRepBlock:

[legend]Collaboration diagram for oofRepBlock:

[legend]List of all members.

---

Detailed Description

Abstract base for a fixed-size block drawn by an oofRepLayoutBand.

multi-method dispatch to factories for rendering report objects.
one for each environment Note: don't use pure virtuals as some subclasses may not implement
virtual void	makeRender (const oofRepMacEnv &)
virtual void	makeRender (const oofRepWinEnv &)
virtual void	makeRender (const oofRepTextEnv &)
virtual void	makeRender (const oofRepRTFEnv &)
virtual void	makeRender (const oofRepHTMLEnv &)
virtual void	makeRender (const oofRepCSVEnv &)
virtual void	makeRender (const oofRepTSVEnv &)
virtual void	makeRender (const oofRepXMLEnv &)
virtual void	makeRender (const oofRepEditingEnv &)
	Just make a renderer for the GUI environment as if not editing because by default most drawables are not editable!
Public Types
enum	blockAlignT { alignLeft, alignCentre, alignRight }
Public Member Functions
	oofRepBlock (oofRepTextStyle *adoptedStyle=0)
virtual	~oofRepBlock ()
virtual oofRepBlock *	clone () const=0
virtual oofRepTextStyle *	textStyle () const
blockAlignT	align () const
oofRepBlock &	align (blockAlignT)
bool	moveDownAfter () const
	Indicate if a layout band should start a new row of blocks.
oofRepBlock &	moveDownAfter (bool)
	Set the flag to be returned by moveDownAfter().
virtual unsigned long	fixedHeight ()
unsigned long	fixedWidth ()
oofRepBlock &	fixedWidth (unsigned long)
virtual unsigned int	countCells () const
virtual oofString	getCellText (bool *outIsEditable=0, oofString *outLocationName=0, long row=0, short col=0) const
virtual void	setCellText (const oofString &, long row=0, short col=0)
virtual void	finishConstruction ()
	null base method occasionally overriden
virtual void	draw ()
	central default call for drawing, but still able to be overriden in extreme cases.
virtual void	describeLayout ()
	central default call like draw() but still able to be overriden in extreme cases.
virtual dbView *	view (unsigned short whichView=0) const
	Request a dbView which may be the source of data for the item.
virtual unsigned long	width ()
virtual oofRepEditLink *	makeEditLink (const oofRepEditingEnv &)
	Make an editor for this drawable - by default return a null link.
oofString	ID () const
void	ID (const oofString &)
void	clearID ()
oofRepTextStyle *	localTextStyle () const
	Get style owned by this object.
oofRepTextStyle *	uniqueTextStyle ()
	Get a style unique to this object, cloning the one we'd normally use if necessary.
void	textStyle (oofRepTextStyle *adoptedStyle)
	Set style owned by this object.
void	textStyle (const char *fontName, unsigned short fontSize, unsigned char styleNum=0, short leading=0, oofColor color=oofColor::Black)
	Set style owned by this object, creating from the font parameters.
oofAdornerList &	adorners ()
bool	hasAdorners () const
Protected Attributes
unsigned long	mFixedWidth
blockAlignT	mAlignment
bool	mMoveDownAfter
oofRepRender *	mRender
oofString	mID
oofRepTextStyle *	mStyle

---

Member Enumeration Documentation

enum oofRepBlock::blockAlignT

Enumeration values: alignLeft  alignCentre  alignRight

---

Constructor & Destructor Documentation

oofRepBlock::oofRepBlock (  oofRepTextStyle *  adoptedStyle = 0  )

virtual oofRepBlock::~oofRepBlock (   )  [inline, virtual]

---

Member Function Documentation

oofAdornerList & OOF_mixAdornable::adorners (   )  [inline, inherited]

oofRepBlock & oofRepBlock::align (  blockAlignT   )

oofRepBlock::blockAlignT oofRepBlock::align (   )  const [inline]

void oofRepDrawable::clearID (   )  [inline, inherited]

virtual oofRepBlock* oofRepBlock::clone (   )  const [pure virtual]

Implemented in oofRepTextBlock, oofRepPictBlock, oofRepFieldBlock, and oofRepPageNoBlock.

unsigned int oofRepBlock::countCells (   )  const [virtual]

Reimplemented in oofRepTextBlock, oofRepBracketedTextBlock, and oofRepPictBlock.

void oofRepDrawable::describeLayout (   )  [virtual, inherited]

central default call like draw() but still able to be overriden in extreme cases. Provides a second virtual function for renderers used by backends such as XML which have distinct drawing time and declarative time operations

void oofRepDrawable::draw (   )  [virtual, inherited]

central default call for drawing, but still able to be overriden in extreme cases. Now that all is factored out to the render objects (Strategy pattern) we shouldn't need to do anything.regarding actual output Reimplemented in oofRepGraphBand, oofRepLayoutBand, and oofRepViewBand.

void oofRepDrawable::finishConstruction (   )  [virtual, inherited]

null base method occasionally overriden Reimplemented in oofRepGraphBand.

unsigned long oofRepBlock::fixedHeight (   )  [inline, virtual]

Reimplemented from oofRepDrawable. Reimplemented in oofRepPictBlock.

oofRepBlock & oofRepBlock::fixedWidth (  unsigned  long  )

unsigned long oofRepBlock::fixedWidth (   )  [inline]

oofString oofRepBlock::getCellText (  bool *  outIsEditable = 0, oofString *  outLocationName = 0, long  row = 0, short  col = 0 )  const [virtual]

Reimplemented in oofRepTextBlock, oofRepPictBlock, oofRepFieldBlock, and oofRepPageNoBlock.

bool OOF_mixAdornable::hasAdorners (   )  const [inline, inherited]

void oofRepDrawable::ID (  const oofString &   )  [inline, inherited]

oofString oofRepDrawable::ID (   )  const [inline, inherited]

oofRepTextStyle * oofRepTextStylable::localTextStyle (   )  const [inline, inherited]

Get style owned by this object. Returns: may be null indicating use container's style.

oofRepEditLink * oofRepDrawable::makeEditLink (  const oofRepEditingEnv &  inEnv  )  [virtual, inherited]

Make an editor for this drawable - by default return a null link. Note that this is separated from the making of render wrappers as editing may have its own complexities - a given drawable may therefore provide a subclassed edit link but use standard wrapping. Reimplemented in oofRepViewBand.

void oofRepDrawable::makeRender (  const oofRepEditingEnv &  inEnv  )  [virtual, inherited]

Just make a renderer for the GUI environment as if not editing because by default most drawables are not editable! Reimplemented in oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, and oofRepPictBlock.

void oofRepDrawable::makeRender (  const oofRepXMLEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, oofRepPageNoBlock, and oofRepPictBand.

void oofRepDrawable::makeRender (  const oofRepTSVEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, and oofRepPictBand.

void oofRepDrawable::makeRender (  const oofRepCSVEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, and oofRepPictBand.

void oofRepDrawable::makeRender (  const oofRepHTMLEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, and oofRepPictBand.

void oofRepDrawable::makeRender (  const oofRepRTFEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, oofRepPageNoBlock, oofRepPictBand, and oofRepFreeImageBand.

void oofRepDrawable::makeRender (  const oofRepTextEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, and oofRepPictBand.

void oofRepDrawable::makeRender (  const oofRepWinEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, oofRepPictBand, and oofRepFreeImageBand.

void oofRepDrawable::makeRender (  const oofRepMacEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, and oofRepPictBand.

oofRepBlock & oofRepBlock::moveDownAfter (  bool  b  )

Set the flag to be returned by moveDownAfter(). Same effect achieved by ending an oofRepTextBlock with a linefeed.

bool oofRepBlock::moveDownAfter (   )  const [inline]

Indicate if a layout band should start a new row of blocks. Returns: true when this is the last block in the row.

void oofRepBlock::setCellText (  const oofString &  , long  row = 0, short  col = 0 )  [virtual]

Reimplemented in oofRepTextBlock, oofRepFieldBlock, and oofRepPageNoBlock.

void oofRepTextStylable::textStyle (  const char *  fontName, unsigned short  fontSize, unsigned char  styleNum = 0, short  leading = 0, oofColor  color = oofColor::Black )  [inherited]

Set style owned by this object, creating from the font parameters.

void oofRepTextStylable::textStyle (  oofRepTextStyle *  adoptedStyle  )  [inherited]

Set style owned by this object.

oofRepTextStyle * oofRepBlock::textStyle (   )  const [virtual]

Returns: text style of this block or whatever's drawing it. Can cope with no currentLayout as may be called when not drawing. See also: OOF_repXMLstyleCleanupVisitor::VisitDrawable Reimplemented from oofRepTextStylable.

oofRepTextStyle * oofRepTextStylable::uniqueTextStyle (   )  [inherited]

Get a style unique to this object, cloning the one we'd normally use if necessary. Return values: Always  returns a style.

dbView * oofRepDrawable::view (  unsigned short  whichView = 0  )  const [virtual, inherited]

Request a dbView which may be the source of data for the item. Parameters: whichView  is zero-based index of views. eg: oofRepGraphBand has more than one view for some graph types. Returns: null by default if no band matching index Reimplemented in oofRepGraphBand, and oofRepViewBand.

unsigned long oofRepDrawable::width (   )  [virtual, inherited]

Reimplemented in oofRepPictBlock.

---

Member Data Documentation

blockAlignT oofRepBlock::mAlignment [protected]

unsigned long oofRepBlock::mFixedWidth [protected]

oofString oofRepDrawable::mID [protected, inherited]

bool oofRepBlock::mMoveDownAfter [protected]

oofRepRender* oofRepDrawable::mRender [protected, inherited]

oofRepTextStyle* oofRepTextStylable::mStyle [protected, inherited]

---

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

• oofrep.h
• oofrep1.cpp

---