OOFILE  1.9
Public Types | Public Member Functions | Protected Attributes | List of all members

Specify a block to draw an oofPict in an oofRepLayoutBand. More...

#include <oofrep.h>

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

Public Types

enum  blockAlignT { alignLeft, alignCentre, alignRight }
 

Public Member Functions

oofAdornerListadorners ()
 
blockAlignT align () const
 
oofRepBlockalign (blockAlignT)
 
void clearID ()
 
virtual oofRepBlockclone () const
 
virtual unsigned int countCells () const
 
virtual void describeLayout ()
 central default call like draw() but still able to be overriden in extreme cases. More...
 
virtual void draw ()
 central default call for drawing, but still able to be overriden in extreme cases. More...
 
virtual void finishConstruction ()
 null base method occasionally overriden More...
 
virtual unsigned long fixedHeight ()
 
unsigned long fixedWidth ()
 
oofRepBlockfixedWidth (unsigned long)
 
virtual oofString getCellText (bool *outIsEditable=0, oofString *outLocationName=0, long row=0, short col=0) const
 
bool hasAdorners () const
 
unsigned long height ()
 
oofString ID () const
 
void ID (const oofString &)
 
oofRepTextStylelocalTextStyle () const
 Get style owned by this object. More...
 
virtual oofRepEditLinkmakeEditLink (const oofRepEditingEnv &)
 Make an editor for this drawable - by default return a null link. More...
 
virtual void makeRender (const oofRepMacEnv &env)
 
virtual void makeRender (const oofRepMacCGEnv &env)
 
virtual void makeRender (const oofRepWinEnv &env)
 
virtual void makeRender (const oofRepGDIPlusEnv &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! More...
 
bool moveDownAfter () const
 Indicate if a layout band should start a new row of blocks. More...
 
oofRepBlockmoveDownAfter (bool)
 Set the flag to be returned by moveDownAfter(). More...
 
 oofRepPictBlock (oofPict *adoptedPict, oofRepTextStyle *adoptedStyle=0)
 
oofPictpicture () const
 
virtual void setCellText (const oofString &, long row=0, short col=0)
 
void textStyle (oofRepTextStyle *adoptedStyle)
 Set style owned by this object. More...
 
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. More...
 
virtual oofRepTextStyletextStyle () const
 
oofRepTextStyleuniqueTextStyle ()
 Get a style unique to this object, cloning the one we'd normally use if necessary. More...
 
virtual dbViewview (unsigned short whichView=0) const
 Request a dbView which may be the source of data for the item. More...
 
virtual unsigned long width ()
 

Protected Attributes

blockAlignT mAlignment
 
unsigned long mFixedWidth
 
oofString mID
 
bool mMoveDownAfter
 
oofRepRendermRender
 
oofRepTextStylemStyle
 

Detailed Description

Specify a block to draw an oofPict in an oofRepLayoutBand.

Definition at line 1516 of file oofrep.h.

Constructor & Destructor Documentation

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

Definition at line 989 of file oofrep2.cpp.

Referenced by clone().

Member Function Documentation

oofAdornerList & OOF_mixAdornable::adorners ( )
inlineinherited
oofRepBlock::blockAlignT oofRepBlock::align ( ) const
inlineinherited
oofRepBlock & oofRepBlock::align ( oofRepBlock::blockAlignT  A)
inherited

Definition at line 1589 of file oofrep1.cpp.

References oofRepBlock::mAlignment.

void oofRepDrawable::clearID ( )
inlineinherited

Definition at line 1863 of file oofrep.h.

References oofString::clear(), and oofRepDrawable::mID.

Referenced by OOF_repXMLclearIDVisitor::VisitDrawable().

oofRepBlock * oofRepPictBlock::clone ( ) const
virtual

Implements oofRepBlock.

Definition at line 996 of file oofrep2.cpp.

References oofRepPictBlock().

unsigned int oofRepPictBlock::countCells ( ) const
virtual

Reimplemented from oofRepBlock.

Definition at line 1027 of file oofrep2.cpp.

void oofRepDrawable::describeLayout ( )
virtualinherited

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

Definition at line 1265 of file oofrep1.cpp.

References oofRepRender::describeLayout(), and oofRepDrawable::mRender.

Referenced by OOF_repXMLlayoutVisitor::VisitDrawable().

void oofRepDrawable::draw ( )
virtualinherited
void oofRepDrawable::finishConstruction ( )
virtualinherited

null base method occasionally overriden

Reimplemented in oofRepGraphBand.

Definition at line 1242 of file oofrep1.cpp.

Referenced by oofRepBreak::finishConstruction(), and OOF_repFinishConstructionVisitor::VisitDrawable().

unsigned long oofRepPictBlock::fixedHeight ( )
virtual
unsigned long oofRepBlock::fixedWidth ( )
inlineinherited
oofRepBlock & oofRepBlock::fixedWidth ( unsigned long  inWidth)
inherited

Definition at line 1597 of file oofrep1.cpp.

References oofRepBlock::mFixedWidth.

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

Reimplemented from oofRepBlock.

Definition at line 1034 of file oofrep2.cpp.

References oofPict::describe(), and OOF_mixPictOwner::picture().

bool OOF_mixAdornable::hasAdorners ( ) const
inlineinherited

Definition at line 361 of file oofadorn.h.

References oofAdornerList::count().

Referenced by OOF_repXMLstyleVisitor::VisitDrawable().

unsigned long OOF_mixPictOwner::height ( )
inlineinherited

Definition at line 427 of file oofdraw.h.

References oofPict::height().

Referenced by fixedHeight(), and oofRepPictBand::fixedHeight().

oofString oofRepDrawable::ID ( ) const
inlineinherited
void oofRepDrawable::ID ( const oofString inID)
inlineinherited

Definition at line 1855 of file oofrep.h.

References oofString::isEmpty(), and oofRepDrawable::mID.

oofRepTextStyle * oofRepTextStylable::localTextStyle ( ) const
inlineinherited

Get style owned by this object.

Returns
may be null indicating use container's style.

Definition at line 2654 of file oofrep.h.

References oofRepTextStylable::mStyle.

Referenced by oofRepEditLink::localTextStyle(), and OOF_repXMLstyleVisitor::VisitDrawable().

oofRepEditLink * oofRepDrawable::makeEditLink ( const oofRepEditingEnv inEnv)
virtualinherited

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.

Definition at line 1421 of file oofrep1.cpp.

void oofRepPictBlock::makeRender ( const oofRepMacEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 177 of file oofrepMac.cpp.

References oofRepDrawable::mRender.

Referenced by makeRender().

void oofRepPictBlock::makeRender ( const oofRepMacCGEnv &  env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 147 of file oofrpdum.cpp.

void oofRepPictBlock::makeRender ( const oofRepWinEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 169 of file oofrpWin.cpp.

void oofRepPictBlock::makeRender ( const oofRepGDIPlusEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 286 of file oofrpdum.cpp.

void oofRepPictBlock::makeRender ( const oofRepTextEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 157 of file oofrptxt.cpp.

References oofRepDrawable::mRender.

void oofRepPictBlock::makeRender ( const oofRepRTFEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 617 of file oofrpRTF.cpp.

References oofRepDrawable::mRender.

void oofRepPictBlock::makeRender ( const oofRepHTMLEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 220 of file oofrpHTM.cpp.

References oofRepDrawable::mRender.

void oofRepPictBlock::makeRender ( const oofRepCSVEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 222 of file oofrpCSV.cpp.

References oofRepDrawable::mRender.

void oofRepPictBlock::makeRender ( const oofRepTSVEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 223 of file oofrpTSV.cpp.

References oofRepDrawable::mRender.

void oofRepPictBlock::makeRender ( const oofRepXMLEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 1410 of file oofrpXML.cpp.

References oofRepDrawable::mRender.

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.

Definition at line 253 of file oofrepedit.cpp.

References oofRepEditingEnv::editor(), oofRepEditor::makeDefaultBlockRenderWrapper(), makeRender(), oofRepDrawable::mRender, and oofRepEditingEnv::parentGUIenv().

bool oofRepBlock::moveDownAfter ( ) const
inlineinherited
oofRepBlock & oofRepBlock::moveDownAfter ( bool  b)
inherited

Set the flag to be returned by moveDownAfter().

Same effect achieved by ending an oofRepTextBlock with a linefeed.

Definition at line 1609 of file oofrep1.cpp.

References oofRepBlock::mMoveDownAfter.

oofPict * OOF_mixPictOwner::picture ( ) const
inlineinherited
void oofRepBlock::setCellText ( const oofString ,
long  row = 0,
short  col = 0 
)
virtualinherited

Reimplemented in oofRepPageNoBlock, oofRepFieldBlock, and oofRepTextBlock.

Definition at line 1655 of file oofrep1.cpp.

Referenced by oofRepLayoutEditLink::setCellText().

void oofRepTextStylable::textStyle ( oofRepTextStyle adoptedStyle)
inherited
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.

Definition at line 1815 of file oofrep1.cpp.

References oofRepTextStylable::mStyle.

oofRepTextStyle * oofRepBlock::textStyle ( ) const
virtualinherited
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.

Definition at line 1622 of file oofrep1.cpp.

References oofRepLayoutBand::currentLayout(), oofRepTextStylable::mStyle, and oofRepTextStylable::textStyle().

Referenced by oofRepTextBlock_MacRender::draw(), oofRepBlock::fixedHeight(), and oofRepTextBlock_MacRender::width().

oofRepTextStyle * oofRepTextStylable::uniqueTextStyle ( )
inherited

Get a style unique to this object, cloning the one we'd normally use if necessary.

Return values
Alwaysreturns a style.

Definition at line 1842 of file oofrep1.cpp.

References oofRepTextStyle::clone(), oofRepTextStylable::mStyle, and oofRepTextStylable::textStyle().

dbView * oofRepDrawable::view ( unsigned short  whichView = 0) const
virtualinherited

Request a dbView which may be the source of data for the item.

Parameters
whichViewis 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 oofRepViewBand, and oofRepGraphBand.

Definition at line 1253 of file oofrep1.cpp.

Referenced by oofRepSection::drawSection(), OOF_repXMLschemaVisitor::VisitComplexBand(), OOF_repXMLlayoutVisitor::VisitComplexBand(), oofRepSchemaVisitor::VisitDrawable(), OOF_repEditSetupVisitor::VisitIterableBandBody(), and OOF_repXMLlayoutVisitor::WriteColumns().

unsigned long oofRepPictBlock::width ( )
virtual

Member Data Documentation

blockAlignT oofRepBlock::mAlignment
protectedinherited

Definition at line 1436 of file oofrep.h.

Referenced by oofRepBlock::align(), and oofRepPageNoBlock::oofRepPageNoBlock().

unsigned long oofRepBlock::mFixedWidth
protectedinherited

Definition at line 1435 of file oofrep.h.

Referenced by fixedHeight(), oofRepBlock::fixedWidth(), and width().

oofString oofRepDrawable::mID
protectedinherited

Definition at line 902 of file oofrep.h.

Referenced by oofRepDrawable::clearID(), and oofRepDrawable::ID().

bool oofRepBlock::mMoveDownAfter
protectedinherited

Definition at line 1437 of file oofrep.h.

Referenced by oofRepBlock::moveDownAfter().

oofRepRender* oofRepDrawable::mRender
protectedinherited
oofRepTextStyle* oofRepTextStylable::mStyle
protectedinherited

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