oofRepPictBlock Class Reference
[OOFILE Report writer]

#include <oofrep.h>

Inheritance diagram for oofRepPictBlock:

[legend]Collaboration diagram for oofRepPictBlock:

[legend]List of all members.

---

Detailed Description

Specify a block to draw an oofPict in an oofRepLayoutBand.

Public Types
enum	blockAlignT { alignLeft, alignCentre, alignRight }
Public Member Functions
	oofRepPictBlock (oofPict *adoptedPict, oofRepTextStyle *adoptedStyle=0)
virtual oofRepBlock *	clone () const
virtual unsigned long	fixedHeight ()
virtual unsigned long	width ()
virtual void	makeRender (const oofRepMacEnv &env)
virtual void	makeRender (const oofRepWinEnv &env)
virtual void	makeRender (const oofRepTextEnv &env)
virtual void	makeRender (const oofRepRTFEnv &env)
virtual void	makeRender (const oofRepHTMLEnv &env)
virtual void	makeRender (const oofRepCSVEnv &env)
virtual void	makeRender (const oofRepTSVEnv &env)
virtual void	makeRender (const oofRepXMLEnv &env)
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!
virtual unsigned int	countCells () const
virtual oofString	getCellText (bool *outIsEditable=0, oofString *outLocationName=0, long row=0, short col=0) const
virtual oofRepTextStyle *	textStyle () const
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.
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().
unsigned long	fixedWidth ()
oofRepBlock &	fixedWidth (unsigned long)
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 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.
oofAdornerList &	adorners ()
bool	hasAdorners () const
oofPict *	picture () const
unsigned long	height ()
Protected Attributes
unsigned long	mFixedWidth
blockAlignT	mAlignment
bool	mMoveDownAfter
oofRepRender *	mRender
oofString	mID
oofRepTextStyle *	mStyle

---

Member Enumeration Documentation

enum oofRepBlock::blockAlignT [inherited]

Enumeration values: alignLeft  alignCentre  alignRight

---

Constructor & Destructor Documentation

oofRepPictBlock::oofRepPictBlock (  oofPict *  adoptedPict, oofRepTextStyle *  adoptedStyle = 0 )

---

Member Function Documentation

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

oofRepBlock & oofRepBlock::align (  blockAlignT   )  [inherited]

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

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

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

Implements oofRepBlock.

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

Reimplemented from oofRepBlock.

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 oofRepPictBlock::fixedHeight (   )  [virtual]

Reimplemented from oofRepBlock.

oofRepBlock & oofRepBlock::fixedWidth (  unsigned  long  )  [inherited]

unsigned long oofRepBlock::fixedWidth (   )  [inline, inherited]

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

Reimplemented from oofRepBlock.

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

unsigned long OOF_mixPictOwner::height (   )  [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 oofRepPictBlock::makeRender (  const oofRepEditingEnv &  inEnv  )  [virtual]

Just make a renderer for the GUI environment as if not editing because by default most drawables are not editable! Reimplemented from oofRepDrawable.

void oofRepPictBlock::makeRender (  const oofRepXMLEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

void oofRepPictBlock::makeRender (  const oofRepTSVEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

void oofRepPictBlock::makeRender (  const oofRepCSVEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

void oofRepPictBlock::makeRender (  const oofRepHTMLEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

void oofRepPictBlock::makeRender (  const oofRepRTFEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

void oofRepPictBlock::makeRender (  const oofRepTextEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

void oofRepPictBlock::makeRender (  const oofRepWinEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

void oofRepPictBlock::makeRender (  const oofRepMacEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

oofRepBlock & oofRepBlock::moveDownAfter (  bool  b  )  [inherited]

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

bool oofRepBlock::moveDownAfter (   )  const [inline, inherited]

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

oofPict * OOF_mixPictOwner::picture (   )  const [inline, inherited]

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

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, inherited]

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 oofRepPictBlock::width (   )  [virtual]

Reimplemented from OOF_mixPictOwner.

---

Member Data Documentation

blockAlignT oofRepBlock::mAlignment [protected, inherited]

unsigned long oofRepBlock::mFixedWidth [protected, inherited]

oofString oofRepDrawable::mID [protected, inherited]

bool oofRepBlock::mMoveDownAfter [protected, inherited]

oofRepRender* oofRepDrawable::mRender [protected, inherited]

oofRepTextStyle* oofRepTextStylable::mStyle [protected, inherited]

---

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

• oofrep.h
• oofrepMac.cpp
• oofrpWin.cpp
• oofrep2.cpp
• oofrepedit.cpp
• oofrpCSV.cpp
• oofrpHTM.cpp
• oofrpnoed.cpp
• oofrpRTF.cpp
• oofrpTSV.cpp
• oofrptxt.cpp
• oofrpXML.cpp
• oofadCon.cpp

---