Ceylan::XML::XMLText Class Reference

Describes a XML text. More...

#include <CeylanXMLElement.h>

Inheritance diagram for Ceylan::XML::XMLText:

Collaboration diagram for Ceylan::XML::XMLText:

List of all members.

Public Types

enum TextOutputFormat { rawText, html }

Defines what text output formats for TextDisplayable instances are available. More...

Public Member Functions

XMLText ()

Creates an empty XML text.

XMLText (const std::string &text)

Creates a XML text from specified string.

virtual ~XMLText () throw ()

Virtual destructor.

virtual void accept (Visitor &visitor)

Allows given visitor to visit this object, thanks to a callback: 'visitor.visit( *this ) ;'.

virtual std::string getText () const

Returns the text in this element.

virtual void setText (const std::string &newText)

Sets the text of this element.

virtual void saveTo (System::OutputStream &output) const

Saves the instance state to specified stream.

virtual void loadFrom (System::InputStream &input)

Loads a new instance state from specified stream.

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

std::string _text

Text of this element.

Static Protected Attributes

static TextOutputFormat _OutputFormat = rawText

The text format to be used currently by TextDisplayable instances.

Private Member Functions

XMLText (const XMLText &source)

Copy constructor made private to ensure that it will never be called.

XMLText & operator= (const XMLText &source)

Assignment operator made private to ensure that it will never be called.

Detailed Description

Describes a XML text.

A text is an eligible content for a markup.

Definition at line 426 of file CeylanXMLElement.h.

Member Enumeration Documentation

enum Ceylan::TextDisplayable::TextOutputFormat [inherited]

Defines what text output formats for TextDisplayable instances are available.

Enumerator:

rawText
html

Definition at line 124 of file CeylanTextDisplayable.h.

Constructor & Destructor Documentation

XMLText::XMLText ( )

Creates an empty XML text.

Definition at line 267 of file CeylanXMLElement.cc.

XMLText::XMLText ( const std::string & text ) [explicit]

Creates a XML text from specified string.

Definition at line 275 of file CeylanXMLElement.cc.

XMLText::~XMLText ( ) throw () [virtual]

Virtual destructor.

Definition at line 283 of file CeylanXMLElement.cc.

Ceylan::XML::XMLText::XMLText ( const XMLText & 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.

Note:: Made to avoid unwanted hidden clone of the Singleton.

Member Function Documentation

void XMLText::accept ( Visitor & visitor ) [virtual]

Allows given visitor to visit this object, thanks to a callback: 'visitor.visit( *this ) ;'.

Implements the Visitable interface.

Note:: The specified visitor must be a XML visitor, otherwise a VisitException is thrown.

Implements Ceylan::Visitable.

Definition at line 318 of file CeylanXMLElement.cc.

References Ceylan::Visitor::toString(), and Ceylan::XML::XMLVisitor::visit().

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

string XMLText::getText ( ) const [virtual]

Returns the text in this element.

Definition at line 290 of file CeylanXMLElement.cc.

References _text.

void XMLText::loadFrom ( System::InputStream & input ) [virtual]

Loads a new instance state from specified stream.

Parameters:

input

the input stream from which the state will be read.

Exceptions:

SerializationException

if the operation failed.

Implements Ceylan::Serializable.

Definition at line 308 of file CeylanXMLElement.cc.

XMLText& Ceylan::XML::XMLText::operator= ( const XMLText & 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.

void XMLText::saveTo ( System::OutputStream & output ) const [virtual]

Saves the instance state to specified stream.

Parameters:

output

the output stream to which the state will be written.

Exceptions:

SerializationException

if the operation failed.

Note:: The toString is not used as they do not serve the same purpose, and differ in terms of encoding.

Implements Ceylan::XML::XMLElement.

Definition at line 334 of file CeylanXMLElement.cc.

References _text, and Ceylan::System::OutputStream::write().

Referenced by Ceylan::XML::XMLSavingVisitor::visit().

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

void XMLText::setText ( const std::string & newText ) [virtual]

Sets the text of this element.

Definition at line 299 of file CeylanXMLElement.cc.

References _text.

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 XMLText::toString ( Ceylan::VerbosityLevels level = Ceylan::high ) const [virtual]

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 343 of file CeylanXMLElement.cc.

References _text.

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

std::string Ceylan::XML::XMLText::_text [protected]

Text of this element.

Definition at line 539 of file CeylanXMLElement.h.

Referenced by getText(), saveTo(), setText(), and toString().

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


Public Types
enum	TextOutputFormat { rawText, html }
	Defines what text output formats for TextDisplayable instances are available. More...
Public Member Functions
	XMLText ()
	Creates an empty XML text.
	XMLText (const std::string &text)
	Creates a XML text from specified string.
virtual	~XMLText () throw ()
	Virtual destructor.
virtual void	accept (Visitor &visitor)
	Allows given visitor to visit this object, thanks to a callback: 'visitor.visit( *this ) ;'.
virtual std::string	getText () const
	Returns the text in this element.
virtual void	setText (const std::string &newText)
	Sets the text of this element.
virtual void	saveTo (System::OutputStream &output) const
	Saves the instance state to specified stream.
virtual void	loadFrom (System::InputStream &input)
	Loads a new instance state from specified stream.
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
std::string	_text
	Text of this element.
Static Protected Attributes
static TextOutputFormat	_OutputFormat = rawText
	The text format to be used currently by TextDisplayable instances.
Private Member Functions
	XMLText (const XMLText &source)
	Copy constructor made private to ensure that it will never be called.
XMLText &	operator= (const XMLText &source)
	Assignment operator made private to ensure that it will never be called.