DtRwUserQuestion contains the contents of a question that is asked to the user.

Inheritance diagram for DtRwUserQuestion:

Public Member Functions
	DtRwUserQuestion ()

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

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

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

virtual	~DtRwUserQuestion ()

DtRwUserQuestion &	operator= (const DtRwUserQuestion &orig)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual void	setQuestionRespondingTo (const DtString &scriptId, int questionId)

virtual void	questionRespondingTo (DtString &scriptId, int &questionId) const

virtual const DtString &	scriptId () const

virtual int	questionId () const

virtual void	setOptions (const std::vector< DtRwTranslatableStringObject > &)

virtual std::vector < DtRwTranslatableStringObject >	options () const

virtual void	setTitle (const DtRwTranslatableStringObject &)

virtual const DtRwTranslatableStringObject &	title () const

virtual void	setMessage (const DtRwTranslatableStringObject &)

virtual const DtRwTranslatableStringObject &	message () const

virtual void	setDisplayFlags (int)

virtual int	displayFlags () 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)

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	wasUpdatedSince (DtTime t) 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 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
DtRwInt	myQuestionId

DtRwString	myScriptId

DtRwTemplatedListPtr < DtRwTranslatableStringObject, true >	myOptions

DtRwTranslatableStringObject	myTitle

DtRwTranslatableStringObject	myMessage

DtRwInt	myDisplayFlags

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

Additional Inherited Members
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 )()

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

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

Constructor & Destructor Documentation

DtRwUserQuestion::DtRwUserQuestion ( )

default constructor

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

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

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

virtual DtRwUserQuestion::~DtRwUserQuestion ( )

virtual

destructor

Member Function Documentation

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

assignment operator

virtual const char* DtRwUserQuestion::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* DtRwUserQuestion::theXmlType ( )

static

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

virtual const char* DtRwUserQuestion::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

virtual void DtRwUserQuestion::setQuestionRespondingTo	(	const DtString &	scriptId,
		int	questionId
	)

virtual

Sets the script id and question id that this operation represents.

virtual void DtRwUserQuestion::questionRespondingTo	(	DtString &	scriptId,
		int &	questionId
	)		const

virtual

virtual const DtString& DtRwUserQuestion::scriptId ( ) const

virtual

virtual int DtRwUserQuestion::questionId ( ) const

virtual

virtual void DtRwUserQuestion::setOptions ( const std::vector< DtRwTranslatableStringObject > & )

virtual

Sets the options to display to the user.

virtual std::vector<DtRwTranslatableStringObject> DtRwUserQuestion::options ( ) const

virtual

virtual void DtRwUserQuestion::setTitle ( const DtRwTranslatableStringObject & )

virtual

Message box title accessors.

virtual const DtRwTranslatableStringObject& DtRwUserQuestion::title ( ) const

virtual

virtual void DtRwUserQuestion::setMessage ( const DtRwTranslatableStringObject & )

virtual

Message box message body accessors.

virtual const DtRwTranslatableStringObject& DtRwUserQuestion::message ( ) const

virtual

virtual void DtRwUserQuestion::setDisplayFlags ( int )

virtual

Display flag accessors. Values currently supported are 0 - Buttons 1 - Radio buttons 2 - Combo box.

virtual int DtRwUserQuestion::displayFlags ( ) const

virtual

Member Data Documentation

DtRwInt DtRwUserQuestion::myQuestionId

protected

DtRwString DtRwUserQuestion::myScriptId

protected

DtRwTemplatedListPtr<DtRwTranslatableStringObject, true> DtRwUserQuestion::myOptions

protected

DtRwTranslatableStringObject DtRwUserQuestion::myTitle

protected

DtRwTranslatableStringObject DtRwUserQuestion::myMessage

protected

DtRwInt DtRwUserQuestion::myDisplayFlags

protected

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation