Cleanup: remove contributors for CMake files
[blender.git] / intern / ghost / intern / GHOST_EventWheel.h
index 3a5b013034575e017d370fec1df29d849a254842..fd3eea9a4e8ad21cdc5920df81385f2b18689736 100644 (file)
@@ -1,14 +1,8 @@
-/**
- * $Id$
- * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
- *
+/*
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version. The Blender
- * Foundation also sells licenses for use in proprietary software under
- * the Blender License.  See http://www.blender.org/BL/ for information
- * about this.
+ * of the License, or (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  * All rights reserved.
- *
- * The Original Code is: all of this file.
- *
- * Contributor(s): none yet.
- *
- * ***** END GPL/BL DUAL LICENSE BLOCK *****
  */
-/**
- * @file       GHOST_EventWheel.h
+
+/** \file ghost/intern/GHOST_EventWheel.h
+ *  \ingroup GHOST
  * Declaration of GHOST_EventWheel class.
  */
 
-#ifndef _GHOST_EVENT_WHEEL_H_
-#define _GHOST_EVENT_WHEEL_H_
+#ifndef __GHOST_EVENTWHEEL_H__
+#define __GHOST_EVENTWHEEL_H__
 
 #include "GHOST_Event.h"
 
 /**
  * Mouse wheel event.
- * @author     Maarten Gribnau
- * @date       May 11, 2001
+ * The displacement of the mouse wheel is counted in ticks.
+ * A positive value means the wheel is turned away from the user.
  */
 class GHOST_EventWheel : public GHOST_Event
 {
 public:
        /**
         * Constructor.
-        * @param msec          The time this event was generated.
-        * @param type          The type of this event.
-        * @param z                     The displacement of the mouse wheel.
+        * \param msec: The time this event was generated.
+        * \param window: The window of this event.
+        * \param z: The displacement of the mouse wheel.
         */
-       GHOST_EventWheel(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow* window, GHOST_TInt32 z)
-               : GHOST_Event(msec, type, window)
+       GHOST_EventWheel(GHOST_TUns64 msec, GHOST_IWindow *window, GHOST_TInt32 z)
+               : GHOST_Event(msec, GHOST_kEventWheel, window)
        {
                m_wheelEventData.z = z;
                m_data = &m_wheelEventData;
@@ -65,5 +54,4 @@ protected:
 };
 
 
-#endif // _GHOST_EVENT_WHEEL_H_
-
+#endif // __GHOST_EVENTWHEEL_H__