Ceylan::TreeVisitor< Content > Class Template Reference
Tree-dedicated visitor. More...
#include <CeylanTree.h>
Public Types | |
| enum | TextOutputFormat { rawText, html } |
| Defines what text output formats for TextDisplayable instances are available. More... | |
Public Member Functions | |
| TreeVisitor () | |
| virtual | ~TreeVisitor () throw () |
| virtual void | visit (Tree< Content > &tree)=0 |
| Action to perform when visiting a tree node. | |
| virtual void | visit (Content &content)=0 |
| Action to perform when visiting the content of a tree node. | |
| 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::TreeVisitor< Content >
Tree-dedicated visitor.
Definition at line 79 of file CeylanTree.h.
Member Enumeration Documentation
enum Ceylan::TextDisplayable::TextOutputFormat [inherited] |
Defines what text output formats for TextDisplayable instances are available.
Definition at line 124 of file CeylanTextDisplayable.h.
Constructor & Destructor Documentation
| Ceylan::TreeVisitor< Content >::TreeVisitor | ( | ) | [inline, explicit] |
Definition at line 101 of file CeylanTree.h.
| Ceylan::TreeVisitor< Content >::~TreeVisitor | ( | ) | throw () [inline, virtual] |
Definition at line 108 of file CeylanTree.h.
Member Function Documentation
| TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat | ( | ) | [static, inherited] |
Returns the current overall text format to be used by TextDisplayable instances.
Definition at line 63 of file CeylanTextDisplayable.cc.
References Ceylan::TextDisplayable::_OutputFormat.
Referenced by Ceylan::formatStringList(), Ceylan::formatStringMap(), Ceylan::XML::XMLMarkup::toString(), Ceylan::Maths::Linear::Vector3::toString(), Ceylan::Maths::Linear::Vector2::toString(), Ceylan::Maths::Linear::Tripoint::toString(), Ceylan::Module::toString(), Ceylan::Maths::Linear::Matrix3::toString(), Ceylan::Maths::Linear::Matrix2::toString(), Ceylan::Maths::Linear::HomogeneousMatrix3::toString(), and Ceylan::Maths::Linear::Bipoint::toString().
| 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.
- 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().
| virtual void Ceylan::TreeVisitor< Content >::visit | ( | Content & | content | ) | [pure virtual] |
Action to perform when visiting the content of a tree node.
| virtual void Ceylan::TreeVisitor< Content >::visit | ( | Tree< Content > & | tree | ) | [pure virtual] |
Action to perform when visiting a tree node.
Referenced by Ceylan::Tree< Content >::traverseBreadthFirst(), and Ceylan::Tree< Content >::traverseDepthFirst().
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:
