Blender: GHOST_CallbackEventConsumer Class Reference

Blender V3.3

#include <GHOST_CallbackEventConsumer.h>

Inheritance diagram for GHOST_CallbackEventConsumer:

Public Member Functions
	GHOST_CallbackEventConsumer (GHOST_EventCallbackProcPtr eventCallback, GHOST_TUserDataPtr userData)

	~GHOST_CallbackEventConsumer (void)

bool	processEvent (GHOST_IEvent *event)

Public Member Functions inherited from GHOST_IEventConsumer
virtual	~GHOST_IEventConsumer ()

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.

Definition at line 18 of file GHOST_CallbackEventConsumer.h.

Constructor & Destructor Documentation

◆ GHOST_CallbackEventConsumer()

GHOST_CallbackEventConsumer::GHOST_CallbackEventConsumer	(	GHOST_EventCallbackProcPtr	eventCallback,
		GHOST_TUserDataPtr	userData
	)

Constructor.

Parameters

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

Copyright (C) 2001 NaN Technologies B.V.

Definition at line 16 of file GHOST_CallbackEventConsumer.cpp.

References m_eventCallback, and m_userData.

◆ ~GHOST_CallbackEventConsumer()

GHOST_CallbackEventConsumer::~GHOST_CallbackEventConsumer ( void )

inline

Destructor.

Definition at line 31 of file GHOST_CallbackEventConsumer.h.

Member Function Documentation

◆ processEvent()

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.

Implements GHOST_IEventConsumer.

Definition at line 23 of file GHOST_CallbackEventConsumer.cpp.

References m_eventCallback, and m_userData.

Member Data Documentation

◆ m_eventCallback

GHOST_EventCallbackProcPtr GHOST_CallbackEventConsumer::m_eventCallback

protected

The call-back routine invoked.

Definition at line 44 of file GHOST_CallbackEventConsumer.h.

Referenced by GHOST_CallbackEventConsumer(), and processEvent().

◆ m_userData

GHOST_TUserDataPtr GHOST_CallbackEventConsumer::m_userData

protected

The data passed back through the call-back routine.

Definition at line 46 of file GHOST_CallbackEventConsumer.h.

Referenced by GHOST_CallbackEventConsumer(), and processEvent().

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