add back ghost/guardedalloc from trunk
[blender-staging.git] / intern / ghost / intern / GHOST_CallbackEventConsumer.h
1 /*
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file ghost/intern/GHOST_CallbackEventConsumer.h
30  *  \ingroup GHOST
31  * Declaration of GHOST_CallbackEventConsumer class.
32  */
33
34 #ifndef _GHOST_CALLBACK_EVENT_CONSUMER_H_
35 #define _GHOST_CALLBACK_EVENT_CONSUMER_H_
36
37 #include "GHOST_IEventConsumer.h"
38 #include "GHOST_C-api.h"
39
40 /**
41  * Event consumer that will forward events to a call-back routine.
42  * Especially useful for the C-API.
43  * @author      Maarten Gribnau
44  * @date        October 25, 2001
45  */
46 class GHOST_CallbackEventConsumer : public GHOST_IEventConsumer
47 {
48 public:
49         /**
50          * Constructor.
51          * @param       eventCallback   The call-back routine invoked.
52          * @param       userData                The data passed back though the call-back routine.
53          */
54         GHOST_CallbackEventConsumer(
55                 GHOST_EventCallbackProcPtr eventCallback, 
56                 GHOST_TUserDataPtr userData);
57
58         /**
59          * Destructor.
60          */
61         virtual ~GHOST_CallbackEventConsumer(void)
62         {
63         }
64
65         /**
66          * This method is called by an event producer when an event is available.
67          * @param event The event that can be handled or ignored.
68          * @return Indication as to whether the event was handled.
69          */
70         virtual bool processEvent(GHOST_IEvent* event);
71
72 protected:
73         /** The call-back routine invoked. */
74         GHOST_EventCallbackProcPtr      m_eventCallback;
75         /** The data passed back though the call-back routine. */
76         GHOST_TUserDataPtr                      m_userData;
77 };
78
79 #endif // _GHOST_CALLBACK_EVENT_CONSUMER_H_
80