Merge branch 'blender2.7'
[blender.git] / intern / ghost / intern / GHOST_EventKey.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/intern/GHOST_EventKey.h
29  *  \ingroup GHOST
30  * Declaration of GHOST_EventKey class.
31  */
32
33 #ifndef __GHOST_EVENTKEY_H__
34 #define __GHOST_EVENTKEY_H__
35
36 #include "GHOST_Event.h"
37
38 /**
39  * Key event.
40  * \author      Maarten Gribnau
41  * \date        May 11, 2001
42  */
43 class GHOST_EventKey : public GHOST_Event
44 {
45 public:
46         /**
47          * Constructor.
48          * \param msec  The time this event was generated.
49          * \param type  The type of key event.
50          * \param key   The key code of the key.
51          */
52         GHOST_EventKey(GHOST_TUns64 msec,
53                        GHOST_TEventType type,
54                        GHOST_IWindow *window,
55                        GHOST_TKey key)
56                 : GHOST_Event(msec, type, window)
57         {
58                 m_keyEventData.key = key;
59                 m_keyEventData.ascii = '\0';
60                 m_keyEventData.utf8_buf[0] = '\0';
61                 m_data = &m_keyEventData;
62         }
63
64         /**
65          * Constructor.
66          * \param msec  The time this event was generated.
67          * \param type  The type of key event.
68          * \param key   The key code of the key.
69          * \param ascii The ascii code for the key event.
70          */
71         GHOST_EventKey(GHOST_TUns64 msec,
72                        GHOST_TEventType type,
73                        GHOST_IWindow *window,
74                        GHOST_TKey key,
75                        char ascii,
76                        const char utf8_buf[6])
77                 : GHOST_Event(msec, type, window)
78         {
79                 m_keyEventData.key = key;
80                 m_keyEventData.ascii = ascii;
81                 if (utf8_buf) memcpy(m_keyEventData.utf8_buf, utf8_buf, sizeof(m_keyEventData.utf8_buf));
82                 else m_keyEventData.utf8_buf[0] = '\0';
83                 m_data = &m_keyEventData;
84         }
85
86 protected:
87         /** The key event data. */
88         GHOST_TEventKeyData m_keyEventData;
89 };
90
91 #endif // __GHOST_EVENTKEY_H__