Cleanup: remove contributors for CMake files
[blender.git] / intern / ghost / GHOST_IEvent.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 ghost/GHOST_IEvent.h
21  *  \ingroup GHOST
22  * Declaration of GHOST_IEvent interface class.
23  */
24
25 #ifndef __GHOST_IEVENT_H__
26 #define __GHOST_IEVENT_H__
27
28 #include <stddef.h>
29 #include "GHOST_Types.h"
30
31 class GHOST_IWindow;
32
33 /**
34  * Interface class for events received from GHOST.
35  * You should not need to inherit this class. The system will pass these events
36  * to the GHOST_IEventConsumer::processEvent() method of event consumers.<br>
37  * Use the getType() method to retrieve the type of event and the getData()
38  * method to get the event data out. Using the event type you can cast the
39  * event data to the correct event dat structure.
40  * \see GHOST_IEventConsumer#processEvent
41  * \see GHOST_TEventType
42  */
43 class GHOST_IEvent
44 {
45 public:
46         /**
47          * Destructor.
48          */
49         virtual ~GHOST_IEvent()
50         {
51         }
52
53         /**
54          * Returns the event type.
55          * \return The event type.
56          */
57         virtual GHOST_TEventType getType() = 0;
58
59         /**
60          * Returns the time this event was generated.
61          * \return The event generation time.
62          */
63         virtual GHOST_TUns64 getTime() = 0;
64
65         /**
66          * Returns the window this event was generated on,
67          * or NULL if it is a 'system' event.
68          * \return The generating window.
69          */
70         virtual GHOST_IWindow *getWindow() = 0;
71
72         /**
73          * Returns the event data.
74          * \return The event data.
75          */
76         virtual GHOST_TEventDataPtr getData() = 0;
77
78 #ifdef WITH_CXX_GUARDEDALLOC
79         MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_IEvent")
80 #endif
81 };
82
83 #endif // __GHOST_IEVENT_H__