CEvent Class Reference

CEvent. More...

#include <Event.h>

Inheritance diagram for CEvent:

List of all members.

Public Member Functions
	CEvent ()
	CEvent.
virtual	~CEvent ()
	~CEvent
virtual void	SetEventType (uint32)
	SetEventType.
void	SetEventBody (int8 *ptr, uint32 size, bool bCopy=true)
	SetEventBody.
uint32	GetEventType () const
	GetEventType.
uint32	GetEventBodySize () const
	GetEventBodySize.
int8 *	GetEventBody () const
	GetEventBody.

---

Detailed Description

CEvent.

Description: Base class for all the event messages.

Limitations: NONE

---

Constructor & Destructor Documentation

CEvent::CEvent (   )

CEvent. Description: Class constructor Limitations: NONE

CEvent::~CEvent (   )  [virtual]

~CEvent Description: Class deconstructor Limitations: NONE

---

Member Function Documentation

int8 * CEvent::GetEventBody (   )  const

GetEventBody. Description: Returns a copy of the data contained in this event. Returns: A copy of the data contained in this event object. Limitations: The caller of this function is responsible for deleting the returned memory.

uint32 CEvent::GetEventBodySize (   )  const

GetEventBodySize. Description: Returns the size of the body contained in this event. Returns: The size of the body contained in this event. Limitations: NONE

uint32 CEvent::GetEventType (   )  const

GetEventType. Description: Returns the type of this event. Returns: The type of this event. Limitations: NONE

void CEvent::SetEventBody (  int8 *  ptr, uint32  size, bool  bCopy = true )

SetEventBody. Description: Copys size bytes from ptr into this event object. Parameters: ptr  is a pointer to the data to copy into this event. size  is the number of bytes to copy from ptr into this event. Returns: void Limitations: NONE

void CEvent::SetEventType (  uint32  type  )  [virtual]

SetEventType. Description: Sets the type of this event. Parameters: type  is the type to set. Returns: void Limitations: NONE

---

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

• GUI/Event.h
• GUI/Event.cpp

---

Copyright (c) 2005 Matt Bruns, Pat Hammond, Kevin Markussen, Travis Service, Brain Shaver