Merge branch 'blender2.7'
[blender.git] / intern / ghost / GHOST_IEventConsumer.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup GHOST
22  * Declaration of GHOST_IEventConsumer interface class.
23  */
24
25 #ifndef __GHOST_IEVENTCONSUMER_H__
26 #define __GHOST_IEVENTCONSUMER_H__
27
28 #include "GHOST_IEvent.h"
29
30 /**
31  * Interface class for objects interested in receiving events.
32  * Objects interested in events should inherit this class and implement the
33  * processEvent() method. They should then be registered with the system that
34  * they want to receive events. The system will call the processEvent() method
35  * for every installed event consumer to pass events.
36  * \see GHOST_ISystem#addEventConsumer
37  */
38 class GHOST_IEventConsumer
39 {
40 public:
41         /**
42          * Destructor.
43          */
44         virtual ~GHOST_IEventConsumer()
45         {
46         }
47
48         /**
49          * This method is called by the system when it has events to dispatch.
50          * \see GHOST_ISystem#dispatchEvents
51          * \param   event   The event that can be handled or ignored.
52          * \return  Indication as to whether the event was handled.
53          */
54         virtual bool processEvent(GHOST_IEvent *event) = 0;
55
56 #ifdef WITH_CXX_GUARDEDALLOC
57         MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_IEventConsumer")
58 #endif
59 };
60
61 #endif  /* __GHOST_IEVENTCONSUMER_H__ */