Ceylan::ReferentialChangedEvent Class Reference
Events used by a Locatable to notify its Locatable children that its referential changed. More...
#include <CeylanLocatable.h>
Public Types | |
| enum | TextOutputFormat { rawText, html } |
| Defines what text output formats for TextDisplayable instances are available. More... | |
Public Member Functions | |
| ReferentialChangedEvent (EventSource &source) | |
| virtual | ~ReferentialChangedEvent () throw () |
| virtual const std::string | toString (Ceylan::VerbosityLevels level=Ceylan::high) const |
| Returns a user-friendly description of the state of this object. | |
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. | |
Protected Attributes | |
| EventSource * | _source |
| The source of this event. | |
Static Protected Attributes | |
| static TextOutputFormat | _OutputFormat = rawText |
| The text format to be used currently by TextDisplayable instances. | |
Detailed Description
Events used by a Locatable to notify its Locatable children that its referential changed.Definition at line 78 of file CeylanLocatable.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
| ReferentialChangedEvent::ReferentialChangedEvent | ( | EventSource & | source | ) | [explicit] |
Definition at line 67 of file CeylanLocatable.cc.
| ReferentialChangedEvent::~ReferentialChangedEvent | ( | ) | throw () [virtual] |
Definition at line 75 of file CeylanLocatable.cc.
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 string Event::toString | ( | Ceylan::VerbosityLevels | level = Ceylan::high |
) | const [virtual, inherited] |
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.
Definition at line 73 of file CeylanEvent.cc.
References Ceylan::Event::_source, and Ceylan::EventSource::toString().
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().
EventSource* Ceylan::Event::_source [protected, inherited] |
The source of this event.
Definition at line 120 of file CeylanEvent.h.
Referenced by Ceylan::Event::toString().
The documentation for this class was generated from the following files:
