DtRwTranslatableStringObject is a simple class that will keep track of strings that can be translated and also do the translation (if needed) via the translate method.

Inheritance diagram for DtRwTranslatableStringObject:

[legend]

Public Types
typedef boost::function < std::string(const char module, const char stringToTranslate)>	TranslationFunction

Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer

typedef std::vector < DtSymbolString >::iterator	aliasIter

typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter

typedef std::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Public Member Functions
	DtRwTranslatableStringObject ()

	DtRwTranslatableStringObject (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)

	DtRwTranslatableStringObject (const DtString &name, const DtRwTranslatableStringObject &orig, DtReaderWriterRegistry *parentRegistry=0)

	DtRwTranslatableStringObject (const DtRwTranslatableStringObject &orig, DtReaderWriterRegistry *parentRegistry=0)

virtual	~DtRwTranslatableStringObject ()

const DtRwTranslatableStringObject &	operator= (const DtRwTranslatableStringObject &orig)

virtual bool	operator== (const DtRwTranslatableStringObject &orig) const

virtual bool	operator!= (const DtRwTranslatableStringObject &orig) const

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual void	printTo (DtOutputStream &) const

virtual void	addTranslatableString (const DtString &, const DtString &module="DtRwTranslatableStringObject", const DtString &originalString="")

virtual void	addArgument (const DtString &)

virtual void	clear ()

virtual std::string	toFormattedString (bool finalCR=true) const

virtual std::vector< int >	typesFrom (const std::string &fmt, std::string &reformatted) const

DtString	translate (bool finalCR=true) const

TranslationFunction	translationFunction () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static const char *	theXmlType ()

static DtRwTranslatableStringObject	trUtf8 (const DtString &string)

static void	setTranslationFunction (TranslationFunction f)

static std::string	defaultTranslationFunction (const char module, const char toTranslate)

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
DtRwTemplatedListPtr < DtRwString, true >	myStringQueue

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

Static Protected Attributes
static TranslationFunction	theTranslatorFunction

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Additional Inherited Members
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Member Typedef Documentation

typedef boost::function<std::string (const char* module, const char* stringToTranslate)> DtRwTranslatableStringObject::TranslationFunction

Constructor & Destructor Documentation

DtRwTranslatableStringObject::DtRwTranslatableStringObject ( )

DtRwTranslatableStringObject::DtRwTranslatableStringObject	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

DtRwTranslatableStringObject::DtRwTranslatableStringObject	(	const DtString &	name,
		const DtRwTranslatableStringObject &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

DtRwTranslatableStringObject::DtRwTranslatableStringObject	(	const DtRwTranslatableStringObject &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

virtual DtRwTranslatableStringObject::~DtRwTranslatableStringObject ( )

virtual

Virtual DTOR.

Member Function Documentation

const DtRwTranslatableStringObject& DtRwTranslatableStringObject::operator= ( const DtRwTranslatableStringObject & orig )

virtual bool DtRwTranslatableStringObject::operator== ( const DtRwTranslatableStringObject & orig ) const

virtual

comparison operator case sensitive comparison of string lists does not take parent DtReaderWriter values into consideration

virtual bool DtRwTranslatableStringObject::operator!= ( const DtRwTranslatableStringObject & orig ) const

virtual

virtual const char* DtRwTranslatableStringObject::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is. This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtReaderWriter.

static const char* DtRwTranslatableStringObject::theXmlType ( )

static

The type that is used when archiving to an XML stream.

virtual const char* DtRwTranslatableStringObject::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

virtual void DtRwTranslatableStringObject::printTo ( DtOutputStream & ) const

virtual

Puts the individual contents onto the specified output stream with tags.

virtual void DtRwTranslatableStringObject::addTranslatableString	(	const DtString &	,
		const DtString &	module = `"DtRwTranslatableStringObject"`,
		const DtString &	originalString = `""`
	)

virtual

virtual void DtRwTranslatableStringObject::addArgument ( const DtString & )

virtual

virtual void DtRwTranslatableStringObject::clear ( )

virtual

virtual std::string DtRwTranslatableStringObject::toFormattedString ( bool finalCR = true ) const

virtual

virtual std::vector<int> DtRwTranslatableStringObject::typesFrom	(	const std::string &	fmt,
		std::string &	reformatted
	)		const

virtual

Tries to reformat string to use Qt %1, %2 etc and returns the types found as: is a next type. Types can be: 0 - string 1 - integer 2 - double 3 - char.

static DtRwTranslatableStringObject DtRwTranslatableStringObject::trUtf8 ( const DtString & string )

static

Creates a translatable string object with a single translatable string whose module is DtRwTranslatableStringObject.

DtString DtRwTranslatableStringObject::translate ( bool finalCR = true ) const

inline

References DtSymbolString::c_str(), DtIteratorBase< T >::current(), DtReaderWriter::name(), oldBoostSplit(), and source.

static void DtRwTranslatableStringObject::setTranslationFunction ( TranslationFunction f )

inlinestatic

TranslationFunction DtRwTranslatableStringObject::translationFunction ( ) const

inline

static std::string DtRwTranslatableStringObject::defaultTranslationFunction	(	const char *	module,
		const char *	toTranslate
	)

inlinestatic

Member Data Documentation

DtRwTemplatedListPtr<DtRwString, true> DtRwTranslatableStringObject::myStringQueue

protected

TranslationFunction DtRwTranslatableStringObject::theTranslatorFunction

staticprotected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfutil/rwTranslatableStringObject.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation