WooHoo me again ;)
[blender-staging.git] / intern / ghost / GHOST_IEventConsumer.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        May 14, 2001
38  */
39
40 #ifndef _GHOST_IEVENT_CONSUMER_H_
41 #define _GHOST_IEVENT_CONSUMER_H_
42
43 #include "GHOST_IEvent.h"
44
45 /**
46  * Interface class for objects interested in receiving events.
47  */
48 class GHOST_IEventConsumer
49 {
50 public:
51         /**
52          * Destructor.
53          */
54         virtual ~GHOST_IEventConsumer()
55         {
56         }
57
58         /**
59          * This method is called by an event producer when an event is available.
60          * @param event The event that can be handled or ignored.
61          * @return Indication as to whether the event was handled.
62          */
63         virtual bool processEvent(GHOST_IEvent* event) = 0;
64 };
65
66 #endif // _GHOST_EVENT_CONSUMER_H_
67