Welcome to mirror list, hosted at ThFree Co, Russian Federation.

GHOST_CallbackEventConsumer.h « intern « ghost « intern - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 0929ba64c653fe40952fcd77a263e7aa1e01524b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/**
 * $Id$
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */
/**
 * @file	GHOST_CallbackEventConsumer.h
 * Declaration of GHOST_CallbackEventConsumer class.
 */

#ifndef _GHOST_CALLBACK_EVENT_CONSUMER_H_
#define _GHOST_CALLBACK_EVENT_CONSUMER_H_

#include "GHOST_IEventConsumer.h"
#include "GHOST_C-api.h"

/**
 * Event consumer that will forward events to a call-back routine.
 * Especially useful for the C-API.
 * @author	Maarten Gribnau
 * @date	October 25, 2001
 */
class GHOST_CallbackEventConsumer : public GHOST_IEventConsumer
{
public:
	/**
	 * Constructor.
	 * @param	eventCallback	The call-back routine invoked.
	 * @param	userData		The data passed back though the call-back routine.
	 */
	GHOST_CallbackEventConsumer(
		GHOST_EventCallbackProcPtr eventCallback, 
		GHOST_TUserDataPtr userData);

	/**
	 * Destructor.
	 */
	virtual ~GHOST_CallbackEventConsumer(void)
	{
	}

	/**
	 * This method is called by an event producer when an event is available.
	 * @param event	The event that can be handled or ignored.
	 * @return Indication as to whether the event was handled.
	 */
	virtual	bool processEvent(GHOST_IEvent* event);

protected:
	/** The call-back routine invoked. */
	GHOST_EventCallbackProcPtr	m_eventCallback;
	/** The data passed back though the call-back routine. */
	GHOST_TUserDataPtr			m_userData;
};

#endif // _GHOST_CALLBACK_EVENT_CONSUMER_H_