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

Abstract base for drawing text content with some bracketing text in an oofRepLayoutBand. More...

#include <oofrep.h>

Inheritance diagram for oofRepBracketedTextBlock:
Inheritance graph
[legend]
Collaboration diagram for oofRepBracketedTextBlock:
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
 
oofString ID () const
 
void ID (const oofString &)
 
oofString leadingText () const
 
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...
 
 oofRepBracketedTextBlock (const char *leadingText, const char *trailingText, oofRepTextStyle *adoptedStyle=0)
 
virtual void setCellText (const oofString &, long row=0, short col=0)
 
virtual oofString text () const
 
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
 
oofString trailingText () 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 Member Functions

virtual oofString MiddleText () const =0
 

Protected Attributes

blockAlignT mAlignment
 
unsigned long mFixedWidth
 
oofString mID
 
bool mMoveDownAfter
 
oofRepRendermRender
 
oofRepTextStylemStyle
 
oofString mText
 
oofString mTrailingText
 

Detailed Description

Abstract base for drawing text content with some bracketing text in an oofRepLayoutBand.

Definition at line 1490 of file oofrep.h.

Constructor & Destructor Documentation

oofRepBracketedTextBlock::oofRepBracketedTextBlock ( const char *  leadingText,
const char *  trailingText,
oofRepTextStyle adoptedStyle = 0 
)

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 * oofRepTextBlock::clone ( ) const
virtualinherited

Implements oofRepBlock.

Reimplemented in oofRepPageNoBlock, and oofRepFieldBlock.

Definition at line 908 of file oofrep2.cpp.

References oofRepTextBlock::oofRepTextBlock().

unsigned int oofRepBracketedTextBlock::countCells ( ) const
virtual

Reimplemented from oofRepTextBlock.

Definition at line 979 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 oofRepBlock::fixedHeight ( )
inlinevirtualinherited
unsigned long oofRepBlock::fixedWidth ( )
inlineinherited
oofRepBlock & oofRepBlock::fixedWidth ( unsigned long  inWidth)
inherited

Definition at line 1597 of file oofrep1.cpp.

References oofRepBlock::mFixedWidth.

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

Reimplemented from oofRepBlock.

Reimplemented in oofRepPageNoBlock, and oofRepFieldBlock.

Definition at line 929 of file oofrep2.cpp.

References oofString::clear(), and oofRepTextBlock::mText.

bool OOF_mixAdornable::hasAdorners ( ) const
inlineinherited

Definition at line 361 of file oofadorn.h.

References oofAdornerList::count().

Referenced by OOF_repXMLstyleVisitor::VisitDrawable().

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.

oofString oofRepBracketedTextBlock::leadingText ( ) const
inline
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 oofRepTextBlock::makeRender ( const oofRepMacEnv env)
virtualinherited

Reimplemented from oofRepDrawable.

Definition at line 169 of file oofrepMac.cpp.

References oofRepDrawable::mRender.

Referenced by oofRepTextBlock::makeRender().

void oofRepTextBlock::makeRender ( const oofRepMacCGEnv &  env)
virtualinherited

Reimplemented from oofRepDrawable.

Definition at line 140 of file oofrpdum.cpp.

void oofRepTextBlock::makeRender ( const oofRepWinEnv env)
virtualinherited

Reimplemented from oofRepDrawable.

Definition at line 161 of file oofrpWin.cpp.

void oofRepTextBlock::makeRender ( const oofRepGDIPlusEnv env)
virtualinherited

Reimplemented from oofRepDrawable.

Definition at line 279 of file oofrpdum.cpp.

void oofRepTextBlock::makeRender ( const oofRepTextEnv env)
virtualinherited

Reimplemented from oofRepDrawable.

Definition at line 150 of file oofrptxt.cpp.

References oofRepDrawable::mRender.

void oofRepTextBlock::makeRender ( const oofRepRTFEnv env)
virtualinherited

Reimplemented from oofRepDrawable.

Reimplemented in oofRepPageNoBlock.

Definition at line 609 of file oofrpRTF.cpp.

References oofRepDrawable::mRender.

void oofRepTextBlock::makeRender ( const oofRepHTMLEnv env)
virtualinherited

Reimplemented from oofRepDrawable.

Definition at line 212 of file oofrpHTM.cpp.

References oofRepDrawable::mRender.

void oofRepTextBlock::makeRender ( const oofRepCSVEnv env)
virtualinherited

Reimplemented from oofRepDrawable.

Definition at line 214 of file oofrpCSV.cpp.

References oofRepDrawable::mRender.

void oofRepTextBlock::makeRender ( const oofRepTSVEnv env)
virtualinherited

Reimplemented from oofRepDrawable.

Definition at line 215 of file oofrpTSV.cpp.

References oofRepDrawable::mRender.

void oofRepTextBlock::makeRender ( const oofRepXMLEnv env)
virtualinherited

Reimplemented from oofRepDrawable.

Reimplemented in oofRepPageNoBlock.

Definition at line 1402 of file oofrpXML.cpp.

References oofRepDrawable::mRender.

void oofRepTextBlock::makeRender ( const oofRepEditingEnv inEnv)
virtualinherited

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 265 of file oofrepedit.cpp.

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

virtual oofString oofRepBracketedTextBlock::MiddleText ( ) const
protectedpure virtual

Implemented in oofRepPageNoBlock, and oofRepFieldBlock.

Referenced by text().

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.

void oofRepTextBlock::setCellText ( const oofString inString,
long  row = 0,
short  col = 0 
)
virtualinherited

Reimplemented from oofRepBlock.

Reimplemented in oofRepPageNoBlock, and oofRepFieldBlock.

Definition at line 944 of file oofrep2.cpp.

References oofRepTextBlock::mText.

oofString oofRepBracketedTextBlock::text ( ) const
virtual

Reimplemented from oofRepTextBlock.

Definition at line 970 of file oofrep2.cpp.

References MiddleText(), oofRepTextBlock::mText, and mTrailingText.

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().

oofString oofRepBracketedTextBlock::trailingText ( ) const
inline
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 oofRepDrawable::width ( )
virtualinherited

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
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
oofString oofRepTextBlock::mText
protectedinherited
oofString oofRepBracketedTextBlock::mTrailingText
protected

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