makVrv::DtKeyEvent Class Reference

This class encapsulates a Key event. More...

Inheritance diagram for makVrv::DtKeyEvent:

List of all members.

Public Types
enum	KeyEventType { NO_EVENT = 0, KEY_DOWN, KEY_UP }
	Enumerate the types of key events supported. More...
Public Member Functions
	DtKeyEvent ()
	Default constructor.
	DtKeyEvent (KeyEventType eventType, const DtKeyState &KeyState)
	Construct a Key event.
virtual	~DtKeyEvent ()
	Destructor.
	DtKeyEvent (const DtKeyEvent &)
	Copy constructor.
DtKeyEvent &	operator= (const DtKeyEvent &)
	Assignment operator.
const DtKeyState &	keyState () const
	Get the state object associated with this event.
DtKeyState &	keyState ()
	Get the state object associated with this event.
virtual void	setKeyState (const DtKeyState &keyState)
	Set the state object associated with this event.
DtKeyEvent::KeyEventType	eventType () const
	Get the event type this event.
virtual void	setEventType (DtKeyEvent::KeyEventType eventType)
	Set the event type this event.
Protected Attributes
DtKeyEvent::KeyEventType	myEventType
DtKeyState	myKeyState

---

Detailed Description

This class encapsulates a Key event.

---

Member Enumeration Documentation

enum makVrv::DtKeyEvent::KeyEventType

Enumerate the types of key events supported.

Enumerator:

NO_EVENT
KEY_DOWN
KEY_UP

---

Constructor & Destructor Documentation

makVrv::DtKeyEvent::DtKeyEvent

(

)

Default constructor.

makVrv::DtKeyEvent::DtKeyEvent	(	KeyEventType	eventType,
		const DtKeyState &	KeyState
	)

Construct a Key event.

virtual makVrv::DtKeyEvent::~DtKeyEvent

(

)

[virtual]

Destructor.

makVrv::DtKeyEvent::DtKeyEvent

(

const DtKeyEvent &

)

Copy constructor.

---

Member Function Documentation

DtKeyEvent& makVrv::DtKeyEvent::operator=

(

const DtKeyEvent &

)

Assignment operator.

const DtKeyState& makVrv::DtKeyEvent::keyState

(

)

const [inline]

Get the state object associated with this event.

DtKeyState& makVrv::DtKeyEvent::keyState

(

)

[inline]

Get the state object associated with this event.

virtual void makVrv::DtKeyEvent::setKeyState

(

const DtKeyState &

keyState

)

[virtual]

Set the state object associated with this event.

DtKeyEvent::KeyEventType makVrv::DtKeyEvent::eventType

(

)

const [inline]

Get the event type this event.

virtual void makVrv::DtKeyEvent::setEventType

(

DtKeyEvent::KeyEventType

eventType

)

[virtual]

Set the event type this event.

---

Member Data Documentation

DtKeyEvent::KeyEventType makVrv::DtKeyEvent::myEventType [protected]

DtKeyState makVrv::DtKeyEvent::myKeyState [protected]

---

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

• include/vrvCore/DtKeyEvent.h