Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / ghost / intern / GHOST_EventCursor.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 \ingroup GHOST
21  * Declaration of GHOST_EventCursor class.
22  */
23
24 #ifndef __GHOST_EVENTCURSOR_H__
25 #define __GHOST_EVENTCURSOR_H__
26
27 #include "GHOST_Event.h"
28
29 /**
30  * Cursor event.
31  */
32 class GHOST_EventCursor : public GHOST_Event
33 {
34 public:
35         /**
36          * Constructor.
37          * \param msec          The time this event was generated.
38          * \param type          The type of this event.
39          * \param x                     The x-coordinate of the location the cursor was at at the time of the event.
40          * \param y                     The y-coordinate of the location the cursor was at at the time of the event.
41          */
42         GHOST_EventCursor(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow *window, GHOST_TInt32 x, GHOST_TInt32 y)
43                 : GHOST_Event(msec, type, window)
44         {
45                 m_cursorEventData.x = x;
46                 m_cursorEventData.y = y;
47                 m_data = &m_cursorEventData;
48         }
49
50 protected:
51         /** The x,y-coordinates of the cursor position. */
52         GHOST_TEventCursorData m_cursorEventData;
53 };
54
55
56 #endif // __GHOST_EVENTCURSOR_H__