unify include guard defines, __$FILENAME__
[blender-staging.git] / intern / ghost / intern / GHOST_EventString.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/intern/GHOST_EventString.h
29  *  \ingroup GHOST
30  * Declaration of GHOST_EventString class.
31  */
32
33 #ifndef __GHOST_EVENTSTRING_H__
34 #define __GHOST_EVENTSTRING_H__
35
36 #include "GHOST_Event.h"
37
38
39 /**
40  * Generic class for events with string data
41  * @author      Damien Plisson
42  * @date        Feb 1, 2010
43  */
44 class GHOST_EventString : public GHOST_Event
45 {
46 public:
47         /**
48          * Constructor.
49          * @param msec  The time this event was generated.
50          * @param type  The type of this event.
51          * @param window The generating window (or NULL if system event).
52          * @param data_ptr Pointer to the (unformatted) data associated with the event
53          */
54         GHOST_EventString(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow* window, GHOST_TEventDataPtr data_ptr)
55                 : GHOST_Event(msec, type, window)       {
56                         m_data = data_ptr;
57         }
58
59         ~GHOST_EventString()
60         {
61                 if (m_data) free(m_data);
62         }
63 };
64
65 #endif // __GHOST_EVENTSTRING_H__
66