DtMenu Class Reference

class DtMenu: More...

Inheritance diagram for DtMenu:

List of all members.

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)
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
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 &)
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

---

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]

virtual DtlObjPtr DtMenu::getLocalData

(

DtlObjPtr

args

)

[virtual]

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

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 *

)

[protected, virtual]

virtual void DtMenu::merge

(

DtMenuEntry *

)

[protected, virtual]

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

virtual void DtMenu::writeSelf	(	FILE *	fp,
		int	indentLevel,
		bool	writeUnspecified,
		const DtFilename &	path
	)		[protected, virtual]

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