Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / ghost / intern / GHOST_EventString.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_EventString class.
22  */
23
24 #ifndef __GHOST_EVENTSTRING_H__
25 #define __GHOST_EVENTSTRING_H__
26
27 #include "GHOST_Event.h"
28
29
30 /**
31  * Generic class for events with string data
32  */
33 class GHOST_EventString : public GHOST_Event
34 {
35 public:
36         /**
37          * Constructor.
38          * \param msec  The time this event was generated.
39          * \param type  The type of this event.
40          * \param window The generating window (or NULL if system event).
41          * \param data_ptr Pointer to the (unformatted) data associated with the event
42          */
43         GHOST_EventString(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow *window, GHOST_TEventDataPtr data_ptr)
44                 : GHOST_Event(msec, type, window)
45         {
46                 m_data = data_ptr;
47         }
48
49         ~GHOST_EventString()
50         {
51                 if (m_data) free(m_data);
52         }
53 };
54
55 #endif // __GHOST_EVENTSTRING_H__