add back ghost/guardedalloc from trunk
[blender-staging.git] / intern / ghost / intern / GHOST_EventKey.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_EventKey.h
30  *  \ingroup GHOST
31  * Declaration of GHOST_EventKey class.
32  */
33
34 #ifndef _GHOST_EVENT_KEY_H_
35 #define _GHOST_EVENT_KEY_H_
36
37 #include "GHOST_Event.h"
38
39 /**
40  * Key event.
41  * @author      Maarten Gribnau
42  * @date        May 11, 2001
43  */
44 class GHOST_EventKey : public GHOST_Event
45 {
46 public:
47         /**
48          * Constructor.
49          * @param msec  The time this event was generated.
50          * @param type  The type of key event.
51          * @param key   The key code of the key.
52          */
53         GHOST_EventKey(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow* window, GHOST_TKey key)
54                 : GHOST_Event(msec, type, window)
55         {
56                 m_keyEventData.key = key;
57                 m_keyEventData.ascii = '\0';
58                 m_data = &m_keyEventData;
59         }
60         
61         /**
62          * Constructor.
63          * @param msec  The time this event was generated.
64          * @param type  The type of key event.
65          * @param key   The key code of the key.
66          * @param ascii The ascii code for the key event.
67          */
68         GHOST_EventKey(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow* window, GHOST_TKey key, char ascii)
69                 : GHOST_Event(msec, type, window)
70         {
71                 m_keyEventData.key = key;
72                 m_keyEventData.ascii = ascii;
73                 m_data = &m_keyEventData;
74         }
75                 
76 protected:
77         /** The key event data. */
78         GHOST_TEventKeyData m_keyEventData;
79 };
80
81 #endif // _GHOST_EVENT_KEY_H_
82