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