Cleanup: remove redundant, invalid info from headers
[blender.git] / intern / ghost / intern / GHOST_EventWheel.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_EventWheel.h
21  *  \ingroup GHOST
22  * Declaration of GHOST_EventWheel class.
23  */
24
25 #ifndef __GHOST_EVENTWHEEL_H__
26 #define __GHOST_EVENTWHEEL_H__
27
28 #include "GHOST_Event.h"
29
30 /**
31  * Mouse wheel event.
32  * The displacement of the mouse wheel is counted in ticks.
33  * A positive value means the wheel is turned away from the user.
34  * \author      Maarten Gribnau
35  * \date        May 11, 2001
36  */
37 class GHOST_EventWheel : public GHOST_Event
38 {
39 public:
40         /**
41          * Constructor.
42          * \param msec: The time this event was generated.
43          * \param window: The window of this event.
44          * \param z: The displacement of the mouse wheel.
45          */
46         GHOST_EventWheel(GHOST_TUns64 msec, GHOST_IWindow *window, GHOST_TInt32 z)
47                 : GHOST_Event(msec, GHOST_kEventWheel, window)
48         {
49                 m_wheelEventData.z = z;
50                 m_data = &m_wheelEventData;
51         }
52
53 protected:
54         /** The z-displacement of the mouse wheel. */
55         GHOST_TEventWheelData m_wheelEventData;
56 };
57
58
59 #endif // __GHOST_EVENTWHEEL_H__