This stream is used by the scripting classes to be able to send out translatable messages from scripts. More...

Inheritance diagram for DtTranslatableStream:

Public Member Functions
	DtTranslatableStream (DtVrfObject *const vrfObject)
	DtTranslatableStream (const char message, const char module)
	DtTranslatableStream (const DtTranslatableStream &)
virtual	~DtTranslatableStream ()
virtual void	printWarn ()
	Prints out to the various info streams.
virtual void	printError ()
virtual void	printInfo ()
virtual void	printDebug ()
virtual void	printVerbose ()
virtual void	addTranslatableString (const std::string &format, const std::string &module)
	Adds a translatable string to the queue with the given module.
virtual DtTranslatableStream &	argString (const std::string &argument)
	Adds an argument to the queue that will be used in the translatable string.
virtual DtTranslatableStream &	argNumber (double argument)
virtual DtTranslatableStream &	arg (const std::string &argument)
virtual DtTranslatableStream &	arg (const DtString &argument)
virtual DtTranslatableStream &	arg (const char *argument)
virtual DtTranslatableStream &	arg (double argument)
virtual void	printTo (DtOutputStream &) const
	Prints to the given output stream.
virtual std::string	toStdString () const
const DtRwTranslatableStringObject &	translatableStrings () const
Public Member Functions inherited from DtAsciiSerializable
	DtAsciiSerializable ()
	The implementer of this interface should be sure to create a creator function to create an empty object that returns a pointer to this interface.
	DtAsciiSerializable (const DtAsciiSerializable &orig)
virtual	~DtAsciiSerializable ()
virtual std::string	objectTypeC () const
	Returns a std::string version of the objectType.
virtual void	init (void *userData)
	This function is called right after the object is constructed during the deserialization process, but before deserialize() is called.

Static Public Member Functions
static DtAsciiSerializable *	creator ()
	Inherited from DtAsciiSerializable. Returns a new object of this type with default values.
static DtTranslatableStream	trUtf8 (const char *fmt)
static DtTranslatableStream	tr (const char fmt, const char module)
Static Public Member Functions inherited from DtObjectDebugger< DtTranslatableStream >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Member Functions
virtual DtString	objectType () const
	Should return the string name of this object.
DtString	serialize ()
	Inherited from DtAsciiSerializable. Returns a string serialized version of this class.
bool	deserialize (const DtString &data)
	Inherited from DtAsciiSerializable.
Protected Member Functions inherited from DtObjectDebugger< DtTranslatableStream >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtRwTranslatableStringObject	myTranslatableStrings
DtScriptVrfObject	myVrfObject

Detailed Description

This stream is used by the scripting classes to be able to send out translatable messages from scripts.

Use the print... methods to finish off the printing and send the information over the network

Constructor & Destructor Documentation

DtTranslatableStream::DtTranslatableStream ( DtVrfObject *const vrfObject )

DtTranslatableStream::DtTranslatableStream	(	const char *	message,
		const char *	module
	)

DtTranslatableStream::DtTranslatableStream ( const DtTranslatableStream & )

virtual DtTranslatableStream::~DtTranslatableStream ( )

virtual

Member Function Documentation

virtual void DtTranslatableStream::printWarn ( )

virtual

Prints out to the various info streams.

virtual void DtTranslatableStream::printError ( )

virtual

virtual void DtTranslatableStream::printInfo ( )

virtual

virtual void DtTranslatableStream::printDebug ( )

virtual

virtual void DtTranslatableStream::printVerbose ( )

virtual

virtual void DtTranslatableStream::addTranslatableString	(	const std::string &	format,
		const std::string &	module
	)

virtual

Adds a translatable string to the queue with the given module.

virtual DtTranslatableStream& DtTranslatableStream::argString ( const std::string & argument )

virtual

Adds an argument to the queue that will be used in the translatable string.

virtual DtTranslatableStream& DtTranslatableStream::argNumber ( double argument )

virtual

virtual DtTranslatableStream& DtTranslatableStream::arg ( const std::string & argument )

inlinevirtual

virtual DtTranslatableStream& DtTranslatableStream::arg ( const DtString & argument )

inlinevirtual

virtual DtTranslatableStream& DtTranslatableStream::arg ( const char * argument )

inlinevirtual

virtual DtTranslatableStream& DtTranslatableStream::arg ( double argument )

inlinevirtual

static DtAsciiSerializable* DtTranslatableStream::creator ( )

static

Inherited from DtAsciiSerializable. Returns a new object of this type with default values.

virtual void DtTranslatableStream::printTo ( DtOutputStream & ) const

virtual

Prints to the given output stream.

virtual std::string DtTranslatableStream::toStdString ( ) const

virtual

static DtTranslatableStream DtTranslatableStream::trUtf8 ( const char * fmt )

inlinestatic

static DtTranslatableStream DtTranslatableStream::tr	(	const char *	fmt,
		const char *	module
	)

inlinestatic

const DtRwTranslatableStringObject& DtTranslatableStream::translatableStrings ( ) const

inline

virtual DtString DtTranslatableStream::objectType ( ) const

protectedvirtual

Should return the string name of this object.

The object name should not be part of the serialization unless you want it to be, but you should take it into account when implementing both functions.

Implements DtAsciiSerializable.

DtString DtTranslatableStream::serialize ( )

protectedvirtual

Inherited from DtAsciiSerializable. Returns a string serialized version of this class.

Implements DtAsciiSerializable.

bool DtTranslatableStream::deserialize ( const DtString & data )

protectedvirtual

Inherited from DtAsciiSerializable.

Returns true if it could fill its members with the data contained in the string. False otherwise.

Implements DtAsciiSerializable.