Cleanup: remove redundant, invalid info from headers
[blender.git] / intern / ghost / intern / GHOST_EventButton.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 ghost/intern/GHOST_EventButton.h
21  *  \ingroup GHOST
22  * Declaration of GHOST_EventButton class.
23  */
24
25 #ifndef __GHOST_EVENTBUTTON_H__
26 #define __GHOST_EVENTBUTTON_H__
27
28 #include "GHOST_Event.h"
29
30 /**
31  * Mouse button event.
32  * \author      Maarten Gribnau
33  * \date        May 11, 2001
34  */
35 class GHOST_EventButton : public GHOST_Event
36 {
37 public:
38         /**
39          * Constructor.
40          * \param time          The time this event was generated.
41          * \param type          The type of this event.
42          * \param window: The window of this event.
43          * \param button: The state of the buttons were at at the time of the event.
44          */
45         GHOST_EventButton(GHOST_TUns64 time, GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask button)
46                 : GHOST_Event(time, type, window)
47         {
48                 m_buttonEventData.button = button;
49                 m_data = &m_buttonEventData;
50         }
51
52 protected:
53         /** The button event data. */
54         GHOST_TEventButtonData m_buttonEventData;
55 };
56
57 #endif // __GHOST_EVENTBUTTON_H__