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