Inheritance diagram for makVrf::DtMenu:

Public Member Functions
	DtMenu (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	Constructor.
virtual	~DtMenu ()
	Destructor.
	DtMenu (const DtMenu &orig)
	Copy constructor.
DtMenu &	operator= (const DtMenu &orig)
	Assignment operator.
virtual bool	operator== (const DtMenuEntry &) const
virtual const DtList &	entries () const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	addObject (const DtString &item, const DtObjectType &type, int force, const DtString &at="")
virtual void	addEntity (const DtString &item, const DtObjectType &type, int force, const DtString &at="")
virtual bool	creationKeyFor (const DtString &name, DtEntityMapperKey &retKey) const
	Given an object name, fills in the retKey with the entity mapper key used to create the object.
virtual bool	load (const DtFilename &)
	Loads menu from specified file.
virtual bool	save (const DtFilename &)
	Saves file (and comment) to specified file.
virtual void	setComment (const DtString &)
	Get/set comment.
virtual const DtString &	comment () const
virtual DtMenuEntry *	findEntry (DtMenuEntry *) const
	Returns an entry that matches the given one (if there is one)
virtual DtMenuEntry *	findEntry (const DtString &, bool recurse=false) const
	Returns the menu entry that has the specified label. If recursive is false, only looks at this menu.
virtual void	merge (DtMenu *)
	Merges in the supplied menu into this one.
virtual void	add (DtMenuEntry *)
virtual DtMenuEntry *	clone () const
const DtFilename &	filename () const
	Filename read in.
void	setFilename (const DtFilename &)
Public Member Functions inherited from makVrf::DtMenuEntry
	DtMenuEntry (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	Constructor.
virtual	~DtMenuEntry ()
	Destructor.
	DtMenuEntry (const DtMenuEntry &orig)
	Copy constructor.
DtMenuEntry &	operator= (const DtMenuEntry &orig)
	Assignment operator.
virtual DtString	label () const
void	setLabel (const DtString &)
virtual bool	operator!= (const DtMenuEntry &) const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Protected Member Functions
virtual void	copyMenuEntries (const DtList *)
virtual void	merge (DtMenuEntry *)
virtual void	addMenuItem (const DtString &item, const DtObjectType &type, int force, const char *name, const DtString &at)
virtual void	writeSelf (std::string &fp, int i, bool writeUnspecified, const DtFilename &path)
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.

Protected Attributes
DtList	myEntries
DtString	myComment
DtFilename	myFilename
std::set< DtMenuEntry * >	mySetEntries
Protected Attributes inherited from makVrf::DtMenuEntry
DtRwString	myLabel
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

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 )()
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 ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
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)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
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

makVrf::DtMenu::DtMenu	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = `NULL`
	)

Constructor.

virtual makVrf::DtMenu::~DtMenu ( )

virtual

Destructor.

makVrf::DtMenu::DtMenu ( const DtMenu & orig )

Copy constructor.

Member Function Documentation

DtMenu& makVrf::DtMenu::operator= ( const DtMenu & orig )

Assignment operator.

virtual bool makVrf::DtMenu::operator== ( const DtMenuEntry & ) const

virtual

Reimplemented from makVrf::DtMenuEntry.

virtual const DtList& makVrf::DtMenu::entries ( ) const

virtual

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

virtual

Top level to read itself from an input stream.

searchPath is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr makVrf::DtMenu::getLocalData ( DtlObjPtr args )

virtual

virtual DtlObjPtr makVrf::DtMenu::getData	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

virtual

Reimplemented from DtReaderWriter.

virtual void makVrf::DtMenu::addObject	(	const DtString &	item,
		const DtObjectType &	type,
		int	force,
		const DtString &	at = `""`
	)

virtual

virtual void makVrf::DtMenu::addEntity	(	const DtString &	item,
		const DtObjectType &	type,
		int	force,
		const DtString &	at = `""`
	)

virtual

virtual bool makVrf::DtMenu::creationKeyFor	(	const DtString &	name,
		DtEntityMapperKey &	retKey
	)		const

virtual

Given an object name, fills in the retKey with the entity mapper key used to create the object.

If the object does not exist, returns false. Must check all entries to see if they have the specified name, and, it is of DtCreateObjectMenuItem type

virtual bool makVrf::DtMenu::load ( const DtFilename & )

virtual

Loads menu from specified file.

virtual bool makVrf::DtMenu::save ( const DtFilename & )

virtual

Saves file (and comment) to specified file.

virtual void makVrf::DtMenu::setComment ( const DtString & )

virtual

Get/set comment.

virtual const DtString& makVrf::DtMenu::comment ( ) const

virtual

virtual DtMenuEntry* makVrf::DtMenu::findEntry ( DtMenuEntry * ) const

virtual

Returns an entry that matches the given one (if there is one)

virtual DtMenuEntry* makVrf::DtMenu::findEntry	(	const DtString &	,
		bool	recurse = `false`
	)		const

virtual

Returns the menu entry that has the specified label. If recursive is false, only looks at this menu.

virtual void makVrf::DtMenu::merge ( DtMenu * )

virtual

Merges in the supplied menu into this one.

virtual void makVrf::DtMenu::add ( DtMenuEntry * )

virtual

virtual DtMenuEntry* makVrf::DtMenu::clone ( ) const

virtual

Reimplemented from makVrf::DtMenuEntry.

const DtFilename & makVrf::DtMenu::filename ( ) const

inline

Filename read in.

References myFilename.

void makVrf::DtMenu::setFilename ( const DtFilename & f )

inline

References myFilename.

virtual void makVrf::DtMenu::copyMenuEntries ( const DtList * )

protectedvirtual

virtual void makVrf::DtMenu::merge ( DtMenuEntry * )

protectedvirtual

virtual void makVrf::DtMenu::addMenuItem	(	const DtString &	item,
		const DtObjectType &	type,
		int	force,
		const char *	name,
		const DtString &	at
	)

protectedvirtual

virtual void makVrf::DtMenu::writeSelf	(	std::string &	fp,
		int	indentLevel,
		bool	writeUnspecified,
		const DtFilename &	path
	)

protectedvirtual

Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtList makVrf::DtMenu::myEntries

protected

DtString makVrf::DtMenu::myComment

protected

DtFilename makVrf::DtMenu::myFilename

protected

Referenced by filename(), and setFilename().

std::set<DtMenuEntry*> makVrf::DtMenu::mySetEntries

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCore/menu.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation