Filling in branch from trunk
[blender.git] / intern / ghost / intern / GHOST_EventWheel.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL 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. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31 /**
32  * @file        GHOST_EventWheel.h
33  * Declaration of GHOST_EventWheel class.
34  */
35
36 #ifndef _GHOST_EVENT_WHEEL_H_
37 #define _GHOST_EVENT_WHEEL_H_
38
39 #include "GHOST_Event.h"
40
41 /**
42  * Mouse wheel event.
43  * The displacement of the mouse wheel is counted in ticks.
44  * A positive value means the wheel is turned away from the user.
45  * @author      Maarten Gribnau
46  * @date        May 11, 2001
47  */
48 class GHOST_EventWheel : public GHOST_Event
49 {
50 public:
51         /**
52          * Constructor.
53          * @param msec          The time this event was generated.
54          * @param type          The type of this event.
55          * @param z                     The displacement of the mouse wheel.
56          */
57         GHOST_EventWheel(GHOST_TUns64 msec, GHOST_IWindow* window, GHOST_TInt32 z)
58                 : GHOST_Event(msec, GHOST_kEventWheel, window)
59         {
60                 m_wheelEventData.z = z;
61                 m_data = &m_wheelEventData;
62         }
63
64 protected:
65         /** The z-displacement of the mouse wheel. */
66         GHOST_TEventWheelData m_wheelEventData;
67 };
68
69
70 #endif // _GHOST_EVENT_WHEEL_H_
71