Patch to change license to GPL only, from GSR.
[blender.git] / intern / ghost / intern / GHOST_EventWheel.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28 /**
29  * @file        GHOST_EventWheel.h
30  * Declaration of GHOST_EventWheel class.
31  */
32
33 #ifndef _GHOST_EVENT_WHEEL_H_
34 #define _GHOST_EVENT_WHEEL_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 type          The type 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_EVENT_WHEEL_H_
68