DtTranslatableStream Class Reference

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.

Inheritance diagram for DtTranslatableStream:

Public Member Functions
	DtTranslatableStream (DtLocalObject *const obj)
	DtTranslatableStream (const char *message, const char *module)
	DtTranslatableStream (const DtTranslatableStream &)
virtual	~DtTranslatableStream ()
virtual void	printWarn ()
virtual void	printError ()
virtual void	printInfo ()
virtual void	printDebug ()
virtual void	printVerbose ()
virtual void	addTranslatableString (const std::string &format, const std::string &module)
virtual DtTranslatableStream &	argString (const std::string &argument)
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
virtual std::string	toStdString () const
const DtRwTranslatableStringObject &	translatableStrings () const
Public Member Functions inherited from DtAsciiSerializable
	DtAsciiSerializable ()
	DtAsciiSerializable (const DtAsciiSerializable &orig)
virtual	~DtAsciiSerializable ()
virtual std::string	objectTypeC () const
virtual void	init (void *userData)

Static Public Member Functions
static DtAsciiSerializable *	creator ()
static DtTranslatableStream	trUtf8 (const char *fmt)
static DtTranslatableStream	tr (const char *fmt, const char *module)

Protected Member Functions
virtual DtString	objectType () const
DtString	serialize ()
bool	deserialize (const DtString &data)

Protected Attributes
DtRwTranslatableStringObject	myTranslatableStrings
DtScriptOwnshipObject	myVrfObject

Constructor & Destructor Documentation

DtTranslatableStream::DtTranslatableStream

(

DtLocalObject *const

obj

)

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.

Member Data Documentation

DtRwTranslatableStringObject DtTranslatableStream::myTranslatableStrings

protected

DtScriptOwnshipObject DtTranslatableStream::myVrfObject

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjcore/translatableStream.h