Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / ghost / intern / GHOST_EventKey.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_EventKey class.
22  */
23
24 #ifndef __GHOST_EVENTKEY_H__
25 #define __GHOST_EVENTKEY_H__
26
27 #include "GHOST_Event.h"
28
29 /**
30  * Key event.
31  */
32 class GHOST_EventKey : public GHOST_Event
33 {
34 public:
35         /**
36          * Constructor.
37          * \param msec  The time this event was generated.
38          * \param type  The type of key event.
39          * \param key   The key code of the key.
40          */
41         GHOST_EventKey(GHOST_TUns64 msec,
42                        GHOST_TEventType type,
43                        GHOST_IWindow *window,
44                        GHOST_TKey key)
45                 : GHOST_Event(msec, type, window)
46         {
47                 m_keyEventData.key = key;
48                 m_keyEventData.ascii = '\0';
49                 m_keyEventData.utf8_buf[0] = '\0';
50                 m_data = &m_keyEventData;
51         }
52
53         /**
54          * Constructor.
55          * \param msec  The time this event was generated.
56          * \param type  The type of key event.
57          * \param key   The key code of the key.
58          * \param ascii The ascii code for the key event.
59          */
60         GHOST_EventKey(GHOST_TUns64 msec,
61                        GHOST_TEventType type,
62                        GHOST_IWindow *window,
63                        GHOST_TKey key,
64                        char ascii,
65                        const char utf8_buf[6])
66                 : GHOST_Event(msec, type, window)
67         {
68                 m_keyEventData.key = key;
69                 m_keyEventData.ascii = ascii;
70                 if (utf8_buf) memcpy(m_keyEventData.utf8_buf, utf8_buf, sizeof(m_keyEventData.utf8_buf));
71                 else m_keyEventData.utf8_buf[0] = '\0';
72                 m_data = &m_keyEventData;
73         }
74
75 protected:
76         /** The key event data. */
77         GHOST_TEventKeyData m_keyEventData;
78 };
79
80 #endif // __GHOST_EVENTKEY_H__