DtVrfOverlayObjectModify Class Reference

This class will hold information that can be used to modify a overlay object after it has been created (this is called as part of the callback to processOverlayObjectCreated()) More...

List of all members.

Public Member Functions
	DtVrfOverlayObjectModify (int color, const DtString &parentName, const DtString &attachTo, char *userData, int iUserDataSize, DtOverlayCreatedCallbackFcn fcn, DtVrfRemoteController *control)
virtual	~DtVrfOverlayObjectModify ()
virtual int	color () const
virtual const DtString &	parentName () const
virtual const DtString &	attachTo () const
virtual void	userData (char **data, int *userDataSize)
virtual DtVrfRemoteController *	remoteController ()
virtual DtOverlayCreatedCallbackFcn	userCallback ()
Protected Attributes
int	myColor
DtString	myParentName
DtString	myAttachTo
DtVrfRemoteController *	myController
char *	myUserData
int	myUserDataSize
DtOverlayCreatedCallbackFcn	myUserCallback

---

Detailed Description

This class will hold information that can be used to modify a overlay object after it has been created (this is called as part of the callback to processOverlayObjectCreated())

When the user data is set, memory is allocated to hold the size of the data and then the data is copied into a local buffer. You can retrieve a pointer to this buffer and the size by calling the userBuffer() call. Note that this memory will be freed when this object is deleted

---

Constructor & Destructor Documentation

DtVrfOverlayObjectModify::DtVrfOverlayObjectModify	(	int	color,
		const DtString &	parentName,
		const DtString &	attachTo,
		char *	userData,
		int	iUserDataSize,
		DtOverlayCreatedCallbackFcn	fcn,
		DtVrfRemoteController *	control
	)

virtual DtVrfOverlayObjectModify::~DtVrfOverlayObjectModify

(

)

[virtual]

---

Member Function Documentation

virtual int DtVrfOverlayObjectModify::color

(

)

const [virtual]

virtual const DtString& DtVrfOverlayObjectModify::parentName

(

)

const [virtual]

virtual const DtString& DtVrfOverlayObjectModify::attachTo

(

)

const [virtual]

virtual void DtVrfOverlayObjectModify::userData	(	char **	data,
		int *	userDataSize
	)		[virtual]

virtual DtVrfRemoteController* DtVrfOverlayObjectModify::remoteController

(

)

[virtual]

virtual DtOverlayCreatedCallbackFcn DtVrfOverlayObjectModify::userCallback

(

)

[virtual]

---

Member Data Documentation

int DtVrfOverlayObjectModify::myColor [protected]

DtString DtVrfOverlayObjectModify::myParentName [protected]

DtString DtVrfOverlayObjectModify::myAttachTo [protected]

DtVrfRemoteController* DtVrfOverlayObjectModify::myController [protected]

char* DtVrfOverlayObjectModify::myUserData [protected]

int DtVrfOverlayObjectModify::myUserDataSize [protected]

DtOverlayCreatedCallbackFcn DtVrfOverlayObjectModify::myUserCallback [protected]

---

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

• include/vrfcontrol/vrfController.h