Ceylan::TreeHeightAwareVisitor< Content > Class Template Reference

Tree-dedicated visitor, which may use the distance from the current node to the real root of the tree. More...

#include <CeylanTree.h>

Inheritance diagram for Ceylan::TreeHeightAwareVisitor< Content >:

Inheritance graph
[legend]
Collaboration diagram for Ceylan::TreeHeightAwareVisitor< Content >:

Collaboration graph
[legend]

List of all members.

Public Types

enum  TextOutputFormat { rawText, html }
 Defines what text output formats for TextDisplayable instances are available. More...

Public Member Functions

 TreeHeightAwareVisitor ()
 Creates a tree visitor that knows the height of the visited node.
virtual ~TreeHeightAwareVisitor () throw ()
 Virtual destructor.
virtual Height getHeight () const
 Returns current height.
virtual void incrementHeight ()
 Increments current height.
virtual void decrementHeight ()
 Decrements current height.
virtual const std::string toString (Ceylan::VerbosityLevels level=Ceylan::high) const
 Visits a concrete Visitable.

Static Public Member Functions

static const std::string ToString (std::list< TextDisplayable * > displayables, Ceylan::VerbosityLevels level=Ceylan::high)
 Returns a user-friendly description of this list of pointers to text displayable instances.
static TextOutputFormat GetOutputFormat ()
 Returns the current overall text format to be used by TextDisplayable instances.
static void SetOutputFormat (TextOutputFormat newOutputFormat)
 Sets the current overall text format to be used by TextDisplayable instances.

Static Protected Attributes

static TextOutputFormat _OutputFormat = rawText
 The text format to be used currently by TextDisplayable instances.


Detailed Description

template<typename Content>
class Ceylan::TreeHeightAwareVisitor< Content >

Tree-dedicated visitor, which may use the distance from the current node to the real root of the tree.

Definition at line 126 of file CeylanTree.h.


Member Enumeration Documentation

Defines what text output formats for TextDisplayable instances are available.

Enumerator:
rawText 
html 

Definition at line 124 of file CeylanTextDisplayable.h.


Constructor & Destructor Documentation

template<typename Content >
Ceylan::TreeHeightAwareVisitor< Content >::TreeHeightAwareVisitor (  )  [inline, explicit]

Creates a tree visitor that knows the height of the visited node.

Definition at line 219 of file CeylanTree.h.

template<typename Content >
Ceylan::TreeHeightAwareVisitor< Content >::~TreeHeightAwareVisitor (  )  throw () [inline, virtual]

Virtual destructor.

Definition at line 227 of file CeylanTree.h.


Member Function Documentation

template<typename Content >
void Ceylan::TreeHeightAwareVisitor< Content >::decrementHeight (  )  [inline, virtual]

Decrements current height.

Note:
A default do-nothing implementation is provided here, it is made to be overriden by the actual algorithm, which may use a single variable, or a stack, etc.

Reimplemented in Ceylan::XML::XMLSavingVisitor.

Definition at line 255 of file CeylanTree.h.

Referenced by Ceylan::Tree< Content >::accept().

template<typename Content >
Height Ceylan::TreeHeightAwareVisitor< Content >::getHeight (  )  const [inline, virtual]

Returns current height.

Note:
A default do-nothing implementation is provided here, it is made to be overriden by the actual algorithm, which may use a single variable, or a stack, etc.

Reimplemented in Ceylan::XML::XMLSavingVisitor.

Definition at line 235 of file CeylanTree.h.

TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat (  )  [static, inherited]

template<typename Content >
void Ceylan::TreeHeightAwareVisitor< Content >::incrementHeight (  )  [inline, virtual]

Increments current height.

Note:
A default do-nothing implementation is provided here, it is made to be overriden by the actual algorithm, which may use a single variable, or a stack, etc.

Reimplemented in Ceylan::XML::XMLSavingVisitor.

Definition at line 245 of file CeylanTree.h.

Referenced by Ceylan::Tree< Content >::accept().

void TextDisplayable::SetOutputFormat ( TextOutputFormat  newOutputFormat  )  [static, inherited]

Sets the current overall text format to be used by TextDisplayable instances.

Parameters:
newOutputFormat the new output format.

Definition at line 72 of file CeylanTextDisplayable.cc.

References Ceylan::TextDisplayable::_OutputFormat.

Referenced by Ceylan::Log::LogHolder::LogHolder().

const std::string TextDisplayable::ToString ( std::list< TextDisplayable * >  displayables,
Ceylan::VerbosityLevels  level = Ceylan::high 
) [static, inherited]

Returns a user-friendly description of this list of pointers to text displayable instances.

Parameters:
displayables a list of pointers to TextDisplayable instances/
level the requested verbosity level.
Note:
Text output format is determined from overall settings.
See also:
toString, Ceylan::VerbosityLevels

Definition at line 45 of file CeylanTextDisplayable.cc.

References Ceylan::formatStringList().

const std::string Visitor::toString ( Ceylan::VerbosityLevels  level = Ceylan::high  )  const [virtual, inherited]

Visits a concrete Visitable.

Note:
Should be declared on the actual visitor (ex: a XMLVisitor) as it must specify the actual visitables it can visit (ex: XML markup, XML text, etc.), and not a more generic type.
virtual void visit( MyFirstConcreteVisitable & concreteVisitable ) ; Returns a user-friendly description of the state of this object.

Parameters:
level the requested verbosity level.
Note:
Text output format is determined from overall settings.
See also:
TextDisplayable

Implements Ceylan::TextDisplayable.

Reimplemented in Ceylan::XML::XMLVisitor, Ceylan::XML::XMLSavingVisitor, and Ceylan::XML::XMLSearchingVisitor.

Definition at line 40 of file CeylanVisitor.cc.

Referenced by Ceylan::XML::XMLText::accept(), Ceylan::XML::XMLMarkup::accept(), and Ceylan::Tree< Content >::accept().


Member Data Documentation

TextDisplayable::TextOutputFormat TextDisplayable::_OutputFormat = rawText [static, protected, inherited]

The text format to be used currently by TextDisplayable instances.

Note:
Defaults to raw text.

Definition at line 158 of file CeylanTextDisplayable.h.

Referenced by Ceylan::TextDisplayable::GetOutputFormat(), and Ceylan::TextDisplayable::SetOutputFormat().


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

Generated on Thu Jun 4 20:40:09 2009 for Ceylan by  doxygen 1.5.8