28326653b3187b4d6698d6bf421a352eb8565d66
[blender.git] / intern / ghost / intern / GHOST_CallbackEventConsumer.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL 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. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  * @author      Maarten Gribnau
37  * @date        October 25, 2001
38  */
39
40 #ifndef _GHOST_CALLBACK_EVENT_CONSUMER_H_
41 #define _GHOST_CALLBACK_EVENT_CONSUMER_H_
42
43 #include "GHOST_IEventConsumer.h"
44 #include "GHOST_C-api.h"
45
46 /**
47  * Interface class for objects interested in receiving events.
48  */
49 class GHOST_CallbackEventConsumer : public GHOST_IEventConsumer
50 {
51 public:
52         /**
53          * Constructor.
54          */
55         GHOST_CallbackEventConsumer(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         GHOST_EventCallbackProcPtr      m_eventCallback;
74         GHOST_TUserDataPtr                      m_userData;
75 };
76
77 #endif // _GHOST_CALLBACK_EVENT_CONSUMER_H_