Inheritance diagram for 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 DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	addObject (const QString &item, const DtObjectType &type, int force, const QString &at=QString::null)
virtual void	addEntity (const QString &item, const DtObjectType &type, int force, const QString &at=QString::null)
virtual bool	creationKeyFor (const QString &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 QString &)
	Get/set comment.
virtual const QString &	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 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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
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 DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Member Functions
virtual void	copyMenuEntries (const DtList *)
virtual void	merge (DtMenuEntry *)
virtual void	addMenuItem (const QString &item, const DtObjectType &type, int force, const char *name, const QString &at)
virtual void	writeSelf (FILE *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
QString	myComment
DtFilename	myFilename
Protected Attributes inherited from DtMenuEntry
DtRwString	myLabel
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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.

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::pair < DtSymbolString, DtString >	DtVariableNameType
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static DtReaderWriterFactory *	factory ()
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

Detailed Description

class DtMenu:

Instances of DtMenu are

Constructor & Destructor Documentation

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

Constructor.

virtual DtMenu::~DtMenu ( )

virtual

Destructor.

DtMenu::DtMenu ( const DtMenu & orig )

Copy constructor.

Member Function Documentation

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

Assignment operator.

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

virtual

Reimplemented from DtMenuEntry.

virtual const DtList& DtMenu::entries ( ) const

virtual

virtual void DtMenu::getSelf	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		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 DtMenu::getLocalData ( DtlObjPtr args )

virtual

virtual DtlObjPtr DtMenu::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)

virtual

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

Reimplemented from DtReaderWriter.

virtual void DtMenu::addObject	(	const QString &	item,
		const DtObjectType &	type,
		int	force,
		const QString &	at = `QString::null`
	)

virtual

virtual void DtMenu::addEntity	(	const QString &	item,
		const DtObjectType &	type,
		int	force,
		const QString &	at = `QString::null`
	)

virtual

virtual bool DtMenu::creationKeyFor	(	const QString &	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 DtMenu::load ( const DtFilename & )

virtual

Loads menu from specified file.

virtual bool DtMenu::save ( const DtFilename & )

virtual

Saves file (and comment) to specified file.

virtual void DtMenu::setComment ( const QString & )

virtual

Get/set comment.

virtual const QString& DtMenu::comment ( ) const

virtual

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

virtual

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

virtual DtMenuEntry* 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 DtMenu::merge ( DtMenu * )

virtual

Merges in the supplied menu into this one.

virtual void DtMenu::add ( DtMenuEntry * )

virtual

virtual DtMenuEntry* DtMenu::clone ( ) const

virtual

Reimplemented from DtMenuEntry.

const DtFilename & DtMenu::filename ( ) const

inline

Filename read in.

References myFilename.

void DtMenu::setFilename ( const DtFilename & f )

inline

References myFilename.

virtual void DtMenu::copyMenuEntries ( const DtList * )

protectedvirtual

virtual void DtMenu::merge ( DtMenuEntry * )

protectedvirtual

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

protectedvirtual

virtual void DtMenu::writeSelf	(	FILE *	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 DtMenu::myEntries

protected

QString DtMenu::myComment

protected

DtFilename DtMenu::myFilename

protected

Referenced by filename(), and setFilename().

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

include/vrfGuiCommon/menu.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation