Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / ghost / intern / GHOST_EventTrackpad.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_EventTrackpad class.
22  */
23
24 #ifndef __GHOST_EVENTTRACKPAD_H__
25 #define __GHOST_EVENTTRACKPAD_H__
26
27 #include "GHOST_Event.h"
28
29 /**
30  * Trackpad (scroll, magnify, rotate, ...) event.
31  */
32 class GHOST_EventTrackpad : public GHOST_Event
33 {
34 public:
35         /**
36          * Constructor.
37          * \param msec          The time this event was generated.
38          * \param window: The window of this event.
39          * \param subtype       The subtype of the event.
40          * \param x                     The x-delta of the pan event.
41          * \param y                     The y-delta of the pan event.
42          */
43         GHOST_EventTrackpad(GHOST_TUns64 msec,
44                             GHOST_IWindow *window,
45                             GHOST_TTrackpadEventSubTypes subtype,
46                             GHOST_TInt32 x, GHOST_TInt32 y,
47                             GHOST_TInt32 deltaX, GHOST_TInt32 deltaY)
48                 : GHOST_Event(msec, GHOST_kEventTrackpad, window)
49         {
50                 m_trackpadEventData.subtype = subtype;
51                 m_trackpadEventData.x = x;
52                 m_trackpadEventData.y = y;
53                 m_trackpadEventData.deltaX = deltaX;
54                 m_trackpadEventData.deltaY = deltaY;
55                 m_data = &m_trackpadEventData;
56         }
57
58 protected:
59         /** The mouse pan data */
60         GHOST_TEventTrackpadData m_trackpadEventData;
61 };
62
63
64 #endif // _GHOST_EVENT_PAN_H_