#include <CeylanTextIdentifier.h>
Public Types | |
enum | TextOutputFormat { rawText, html } |
Defines what text output formats for TextDisplayable instances are available. More... | |
Public Member Functions | |
TextIdentifier () | |
Basic void constructor. | |
TextIdentifier (const std::string &id) | |
Constructs a TextIdentifier whose identifier is the provided string. | |
virtual | ~TextIdentifier () throw () |
Basic destructor, to ensure it remains virtual. | |
virtual const std::string | toString (Ceylan::VerbosityLevels level=Ceylan::high) const |
Returns a user-friendly description of the state of this object. | |
bool | operator== (const TextIdentifier &otherIdentifier) |
Compares two text identifiers. | |
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 | |
std::string | _id |
The text identifier itself. | |
Static Protected Attributes | |
static TextOutputFormat | _OutputFormat = rawText |
The text format to be used currently by TextDisplayable instances. | |
Private Member Functions | |
TextIdentifier (const TextIdentifier &source) | |
Copy constructor made private to ensure that it will never be called. | |
TextIdentifier & | operator= (const TextIdentifier &source) |
Assignment operator made private to ensure that it will never be called. |
Definition at line 48 of file CeylanTextIdentifier.h.
enum Ceylan::TextDisplayable::TextOutputFormat [inherited] |
Defines what text output formats for TextDisplayable instances are available.
Definition at line 124 of file CeylanTextDisplayable.h.
TextIdentifier::TextIdentifier | ( | ) |
TextIdentifier::TextIdentifier | ( | const std::string & | id | ) | [explicit] |
Constructs a TextIdentifier whose identifier is the provided string.
Definition at line 44 of file CeylanTextIdentifier.cc.
TextIdentifier::~TextIdentifier | ( | ) | throw () [virtual] |
Basic destructor, to ensure it remains virtual.
Definition at line 53 of file CeylanTextIdentifier.cc.
Ceylan::TextIdentifier::TextIdentifier | ( | const TextIdentifier & | source | ) | [private] |
Copy constructor made private to ensure that it will never be called.
The compiler should complain whenever this undefined constructor is called, implicitly or not.
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().
TextIdentifier& Ceylan::TextIdentifier::operator= | ( | const TextIdentifier & | source | ) | [private] |
Assignment operator made private to ensure that it will never be called.
The compiler should complain whenever this undefined operator is called, implicitly or not.
bool TextIdentifier::operator== | ( | const TextIdentifier & | otherIdentifier | ) |
Compares two text identifiers.
Definition at line 60 of file CeylanTextIdentifier.cc.
References _id.
void TextDisplayable::SetOutputFormat | ( | TextOutputFormat | newOutputFormat | ) | [static, inherited] |
Sets the current overall text format to be used by TextDisplayable instances.
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.
displayables | a list of pointers to TextDisplayable instances/ | |
level | the requested verbosity level. |
Definition at line 45 of file CeylanTextDisplayable.cc.
References Ceylan::formatStringList().
const string TextIdentifier::toString | ( | Ceylan::VerbosityLevels | level = Ceylan::high |
) | const [virtual] |
Returns a user-friendly description of the state of this object.
level | the requested verbosity level. |
Implements Ceylan::Identifier.
Reimplemented in Ceylan::Log::ObjectIdentifier.
Definition at line 69 of file CeylanTextIdentifier.cc.
References _id.
std::string Ceylan::TextIdentifier::_id [protected] |
The text identifier itself.
Definition at line 97 of file CeylanTextIdentifier.h.
Referenced by operator==(), and toString().
TextDisplayable::TextOutputFormat TextDisplayable::_OutputFormat = rawText [static, protected, inherited] |
The text format to be used currently by TextDisplayable instances.
Definition at line 158 of file CeylanTextDisplayable.h.
Referenced by Ceylan::TextDisplayable::GetOutputFormat(), and Ceylan::TextDisplayable::SetOutputFormat().