Creating a BGE staging branch.
[blender.git] / intern / ghost / intern / GHOST_EventButton.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_EventButton.h
29  *  \ingroup GHOST
30  * Declaration of GHOST_EventButton class.
31  */
32
33 #ifndef __GHOST_EVENTBUTTON_H__
34 #define __GHOST_EVENTBUTTON_H__
35
36 #include "GHOST_Event.h"
37
38 /**
39  * Mouse button event.
40  * \author      Maarten Gribnau
41  * \date        May 11, 2001
42  */
43 class GHOST_EventButton : public GHOST_Event
44 {
45 public:
46         /**
47          * Constructor.
48          * \param time          The time this event was generated.
49          * \param type          The type of this event.
50          * \param x                     The x-coordinate of the location the cursor was at at the time of the event.
51          * \param y                     The y-coordinate of the location the cursor was at at the time of the event.
52          * \param buttons       The state of the buttons  was at at the time of the event.
53          */
54         GHOST_EventButton(GHOST_TUns64 time, GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask button)
55                 : GHOST_Event(time, type, window)
56         {
57                 m_buttonEventData.button = button;
58                 m_data = &m_buttonEventData;
59         }
60
61 protected:
62         /** The button event data. */
63         GHOST_TEventButtonData m_buttonEventData;
64 };
65
66 #endif // __GHOST_EVENTBUTTON_H__
67