GHOST_CallbackEventConsumer Class Reference

#include <GHOST_CallbackEventConsumer.h>

Inheritance diagram for GHOST_CallbackEventConsumer:

List of all members.

Public Member Functions
	GHOST_CallbackEventConsumer (GHOST_EventCallbackProcPtr eventCallback, GHOST_TUserDataPtr userData)
virtual	~GHOST_CallbackEventConsumer (void)
virtual bool	processEvent (GHOST_IEvent *event)
Protected Attributes
GHOST_EventCallbackProcPtr	m_eventCallback
GHOST_TUserDataPtr	m_userData

---

Detailed Description

Event consumer that will forward events to a call-back routine. Especially useful for the C-API.

Author:

Maarten Gribnau

Date:

October 25, 2001

Definition at line 45 of file GHOST_CallbackEventConsumer.h.

---

Constructor & Destructor Documentation

GHOST_CallbackEventConsumer::GHOST_CallbackEventConsumer	(	GHOST_EventCallbackProcPtr	eventCallback,
		GHOST_TUserDataPtr	userData
	)

Constructor.

Parameters:

eventCallback	The call-back routine invoked.
userData	The data passed back though the call-back routine.

Copyright (C) 2001 NaN Technologies B.V.

Author:

Maarten Gribnau

Date:

October 25, 2001

Definition at line 44 of file GHOST_CallbackEventConsumer.cpp.

References m_eventCallback, and m_userData.

virtual GHOST_CallbackEventConsumer::~GHOST_CallbackEventConsumer

(

void

)

[inline, virtual]

Destructor.

Definition at line 60 of file GHOST_CallbackEventConsumer.h.

---

Member Function Documentation

bool GHOST_CallbackEventConsumer::processEvent

(

GHOST_IEvent *

event

)

[virtual]

This method is called by an event producer when an event is available.

Parameters:

event

The event that can be handled or ignored.

Returns:

Indication as to whether the event was handled.

Definition at line 52 of file GHOST_CallbackEventConsumer.cpp.

References m_eventCallback, and m_userData.

---

Member Data Documentation

GHOST_EventCallbackProcPtr GHOST_CallbackEventConsumer::m_eventCallback [protected]

The call-back routine invoked.

Definition at line 73 of file GHOST_CallbackEventConsumer.h.

Referenced by GHOST_CallbackEventConsumer(), and processEvent().

GHOST_TUserDataPtr GHOST_CallbackEventConsumer::m_userData [protected]

The data passed back though the call-back routine.

Definition at line 75 of file GHOST_CallbackEventConsumer.h.

Referenced by GHOST_CallbackEventConsumer(), and processEvent().

---

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

• GHOST_CallbackEventConsumer.h
• GHOST_CallbackEventConsumer.cpp