GHOST_CallbackEventConsumer Class Reference

#include <GHOST_CallbackEventConsumer.hh>

Inherits GHOST_IEventConsumer.

Public Member Functions
	GHOST_CallbackEventConsumer (GHOST_EventCallbackProcPtr eventCallback, GHOST_TUserDataPtr user_data)
	~GHOST_CallbackEventConsumer () override=default
bool	processEvent (const GHOST_IEvent *event) override
Public Member Functions inherited from GHOST_IEventConsumer
virtual	~GHOST_IEventConsumer ()=default

Protected Attributes
GHOST_EventCallbackProcPtr	event_callback_
GHOST_TUserDataPtr	user_data_

Detailed Description

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

Definition at line 19 of file GHOST_CallbackEventConsumer.hh.

Constructor & Destructor Documentation

GHOST_CallbackEventConsumer()

GHOST_CallbackEventConsumer::GHOST_CallbackEventConsumer	(	GHOST_EventCallbackProcPtr	eventCallback,
		GHOST_TUserDataPtr	user_data )

Constructor.

Parameters

eventCallback	The call-back routine invoked.
user_data	The data passed back through the call-back routine.

Copyright (C) 2001 NaN Technologies B.V.

Definition at line 17 of file GHOST_CallbackEventConsumer.cc.

References event_callback_, and user_data_.

~GHOST_CallbackEventConsumer()

GHOST_CallbackEventConsumer::~GHOST_CallbackEventConsumer ( )

overridedefault

Destructor.

Member Function Documentation

processEvent()

bool GHOST_CallbackEventConsumer::processEvent ( const GHOST_IEvent * event )

overridevirtual

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.

Implements GHOST_IEventConsumer.

Definition at line 24 of file GHOST_CallbackEventConsumer.cc.

References event_callback_, and user_data_.

Member Data Documentation

event_callback_

GHOST_EventCallbackProcPtr GHOST_CallbackEventConsumer::event_callback_

protected

The call-back routine invoked.

Definition at line 43 of file GHOST_CallbackEventConsumer.hh.

Referenced by GHOST_CallbackEventConsumer(), and processEvent().

user_data_

GHOST_TUserDataPtr GHOST_CallbackEventConsumer::user_data_

protected

The data passed back through the call-back routine.

Definition at line 45 of file GHOST_CallbackEventConsumer.hh.

Referenced by GHOST_CallbackEventConsumer(), and processEvent().

---

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

• GHOST_CallbackEventConsumer.hh
• GHOST_CallbackEventConsumer.cc