add back ghost/guardedalloc from trunk
[blender-staging.git] / intern / ghost / intern / GHOST_Event.h
1 /*
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file ghost/intern/GHOST_Event.h
30  *  \ingroup GHOST
31  * Declaration of GHOST_Event class.
32  */
33
34 #ifndef _GHOST_EVENT_H_
35 #define _GHOST_EVENT_H_
36
37 #include "GHOST_IEvent.h"
38
39
40 /**
41  * Base class for events received the operating system.
42  * @author      Maarten Gribnau
43  * @date        May 11, 2001
44  */
45 class GHOST_Event : public GHOST_IEvent
46 {
47 public:
48         /**
49          * Constructor.
50          * @param msec  The time this event was generated.
51          * @param type  The type of this event.
52          * @param window The generating window (or NULL if system event).
53          */
54         GHOST_Event(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow* window)
55                 : m_type(type), m_time(msec), m_window(window), m_data(0)
56         {
57         }
58
59         /**
60          * Returns the event type.
61          * @return The event type.
62          */
63         virtual GHOST_TEventType getType()
64         { 
65                 return m_type;
66         }
67
68         /**
69          * Returns the time this event was generated.
70          * @return The event generation time.
71          */
72         virtual GHOST_TUns64 getTime()
73         {
74                 return m_time;
75         }
76
77         /**
78          * Returns the window this event was generated on, 
79          * or NULL if it is a 'system' event.
80          * @return The generating window.
81          */
82         virtual GHOST_IWindow* getWindow()
83         {
84                 return m_window;
85         }
86
87         /**
88          * Returns the event data.
89          * @return The event data.
90          */
91         virtual GHOST_TEventDataPtr getData()
92         {
93                 return m_data;
94         }
95
96 protected:
97         /** Type of this event. */
98         GHOST_TEventType m_type;
99         /** The time this event was generated. */
100         GHOST_TUns64 m_time;
101         /** Pointer to the generating window. */
102         GHOST_IWindow* m_window;
103         /** Pointer to the event data. */
104         GHOST_TEventDataPtr m_data;
105 };
106
107 #endif // _GHOST_EVENT_H_
108