VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Attributes
DtRwString Class Reference

Description: Readable, Writable DtString Variable substitutions are done on this object when it is read in from the file. More...

Inheritance diagram for DtRwString:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtRwString ()
 default constructor
 DtRwString (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 real constructor
 DtRwString (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtRwString (const DtString &name, const char *fromChars, DtReaderWriterRegistry *const parentRegistry=NULL)
 real constructor from char *
 DtRwString (const DtSymbolString &name, const char *fromChars, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtRwString (const DtString &name, const DtString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtRwString (const DtSymbolString &name, const DtString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtRwString (const DtString &name, const DtRwString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtRwString (const DtSymbolString &name, const DtRwString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtRwString (const DtRwString &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
 copy constructor
DtRwStringoperator= (const DtRwString &orig)
 Assign to DtString. Assigns value only.
DtRwStringoperator= (const char *orig)
DtRwStringoperator= (const DtString &orig)
DtRwStringoperator= (const DtSymbolString &orig)
virtual ~DtRwString ()
virtual void putData (FILE *fp, int indentLevel=0)
 Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
virtual DtString unsubstitutedString () const
virtual void setUnsubstitutedString (const DtString &)
 Sets the unsubstitude string value.
virtual bool containsVariableSubstitutions () const

Protected Attributes

DtString myUnsubstitutedString

Detailed Description

Description: Readable, Writable DtString Variable substitutions are done on this object when it is read in from the file.

Variables are specified as $(<variable-name>). The unsubstituted version of the string is accessable using unsubstitutedString().


Constructor & Destructor Documentation

default constructor

DtRwString::DtRwString ( const DtString name,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)

real constructor

DtRwString::DtRwString ( const DtSymbolString name,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwString::DtRwString ( const DtString name,
const char *  fromChars,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)

real constructor from char *

DtRwString::DtRwString ( const DtSymbolString name,
const char *  fromChars,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwString::DtRwString ( const DtString name,
const DtString fromString,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwString::DtRwString ( const DtSymbolString name,
const DtString fromString,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwString::DtRwString ( const DtString name,
const DtRwString fromString,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwString::DtRwString ( const DtSymbolString name,
const DtRwString fromString,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwString::DtRwString ( const DtRwString orig,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)

copy constructor

virtual DtRwString::~DtRwString ( ) [virtual]

Member Function Documentation

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

Assign to DtString. Assigns value only.

DtRwString& DtRwString::operator= ( const char *  orig)
DtRwString& DtRwString::operator= ( const DtString orig)
DtRwString& DtRwString::operator= ( const DtSymbolString orig)
virtual void DtRwString::putData ( FILE *  fp,
int  indentLevel = 0 
) [virtual]

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtRwString::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
) [virtual]
virtual const char* DtRwString::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.

virtual DtString DtRwString::unsubstitutedString ( ) const [virtual]
Returns:
The string value that was read in from the RW file before any variable substitutions were made.
virtual void DtRwString::setUnsubstitutedString ( const DtString ) [virtual]

Sets the unsubstitude string value.

Should not be called unless this is really an unsubstitude string

virtual bool DtRwString::containsVariableSubstitutions ( ) const [virtual]
Returns:
True only if there were variables substituted in this string when it was read from the file. If this is false, unsubstitutedString() returns the same as the normal string value of this object.

Member Data Documentation


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)