unify include guard defines, __$FILENAME__
[blender-staging.git] / intern / ghost / GHOST_IEventConsumer.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/GHOST_IEventConsumer.h
29  *  \ingroup GHOST
30  * Declaration of GHOST_IEventConsumer interface class.
31  */
32
33 #ifndef __GHOST_IEVENTCONSUMER_H__
34 #define __GHOST_IEVENTCONSUMER_H__
35
36 #include "GHOST_IEvent.h"
37
38 /**
39  * Interface class for objects interested in receiving events.
40  * Objects interested in events should inherit this class and implement the
41  * processEvent() method. They should then be registered with the system that
42  * they want to receive events. The system will call the processEvent() method
43  * for every installed event consumer to pass events.
44  * @see GHOST_ISystem#addEventConsumer
45  * @author      Maarten Gribnau
46  * @date        May 14, 2001
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 the system when it has events to dispatch.
60          * @see GHOST_ISystem#dispatchEvents
61          * @param       event   The event that can be handled or ignored.
62          * @return      Indication as to whether the event was handled.
63          */
64         virtual bool processEvent(GHOST_IEvent* event) = 0;
65         
66 #ifdef WITH_CXX_GUARDEDALLOC
67 public:
68         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GHOST:GHOST_IEventConsumer"); }
69         void operator delete( void *mem ) { MEM_freeN(mem); }
70 #endif
71 };
72
73 #endif // _GHOST_EVENT_CONSUMER_H_
74