doxygen: add newline after \file
[blender.git] / intern / ghost / intern / GHOST_CallbackEventConsumer.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_CallbackEventConsumer class.
23  */
24
25 #ifndef __GHOST_CALLBACKEVENTCONSUMER_H__
26 #define __GHOST_CALLBACKEVENTCONSUMER_H__
27
28 #include "GHOST_IEventConsumer.h"
29 #include "GHOST_C-api.h"
30
31 /**
32  * Event consumer that will forward events to a call-back routine.
33  * Especially useful for the C-API.
34  */
35 class GHOST_CallbackEventConsumer : public GHOST_IEventConsumer
36 {
37 public:
38         /**
39          * Constructor.
40          * \param       eventCallback   The call-back routine invoked.
41          * \param       userData                The data passed back though the call-back routine.
42          */
43         GHOST_CallbackEventConsumer(
44             GHOST_EventCallbackProcPtr eventCallback,
45             GHOST_TUserDataPtr userData);
46
47         /**
48          * Destructor.
49          */
50         ~GHOST_CallbackEventConsumer(void)
51         {
52         }
53
54         /**
55          * This method is called by an event producer when an event is available.
56          * \param event The event that can be handled or ignored.
57          * \return Indication as to whether the event was handled.
58          */
59         bool processEvent(GHOST_IEvent *event);
60
61 protected:
62         /** The call-back routine invoked. */
63         GHOST_EventCallbackProcPtr m_eventCallback;
64         /** The data passed back though the call-back routine. */
65         GHOST_TUserDataPtr m_userData;
66
67 #ifdef WITH_CXX_GUARDEDALLOC
68         MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_CallbackEventConsumer")
69 #endif
70 };
71
72 #endif // __GHOST_CALLBACKEVENTCONSUMER_H__