makVrf::DtMenu Class Reference

Inheritance diagram for makVrf::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 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 &)
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 (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
DtString	myComment
DtFilename	myFilename

---

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 DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[virtual]

virtual DtlObjPtr makVrf::DtMenu::getLocalData

(

DtlObjPtr

args

)

[virtual]

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

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 & DtMenu::filename

(

)

const [inline]

Filename read in.

References myFilename.

void DtMenu::setFilename

(

const DtFilename &

f

)

[inline]

References myFilename.

virtual void makVrf::DtMenu::copyMenuEntries

(

const DtList *

)

[protected, virtual]

virtual void makVrf::DtMenu::merge

(

DtMenuEntry *

)

[protected, virtual]

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

virtual void makVrf::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 makVrf::DtMenu::myEntries [protected]

DtString makVrf::DtMenu::myComment [protected]

DtFilename makVrf::DtMenu::myFilename [protected]

Referenced by filename(), and setFilename().

---

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

• include/vrfGuiCore/DtMenu.h