Fix for [#27142] manipulator in particle mode does not work
[blender-staging.git] / intern / ghost / GHOST_IEvent.h
1 /*
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file ghost/GHOST_IEvent.h
30  *  \ingroup GHOST
31  * Declaration of GHOST_IEvent interface class.
32  */
33
34 #ifndef _GHOST_IEVENT_H_
35 #define _GHOST_IEVENT_H_
36
37 #include <stddef.h>
38 #include "GHOST_Types.h"
39
40 class GHOST_IWindow;
41
42 /**
43  * Interface class for events received from GHOST.
44  * You should not need to inherit this class. The system will pass these events
45  * to the GHOST_IEventConsumer::processEvent() method of event consumers.<br>
46  * Use the getType() method to retrieve the type of event and the getData() 
47  * method to get the event data out. Using the event type you can cast the 
48  * event data to the correct event dat structure.
49  * @see GHOST_IEventConsumer#processEvent
50  * @see GHOST_TEventType
51  * @author      Maarten Gribnau
52  * @date        May 31, 2001
53  */
54 class GHOST_IEvent
55 {
56 public:
57         /**
58          * Destructor.
59          */
60         virtual ~GHOST_IEvent()
61         {
62         }
63
64         /**
65          * Returns the event type.
66          * @return The event type.
67          */
68         virtual GHOST_TEventType getType() = 0;
69
70         /**
71          * Returns the time this event was generated.
72          * @return The event generation time.
73          */
74         virtual GHOST_TUns64 getTime() = 0;
75
76         /**
77          * Returns the window this event was generated on, 
78          * or NULL if it is a 'system' event.
79          * @return The generating window.
80          */
81         virtual GHOST_IWindow* getWindow() = 0;
82         
83         /**
84          * Returns the event data.
85          * @return The event data.
86          */
87         virtual GHOST_TEventDataPtr getData() = 0;
88         
89 #ifdef WITH_CXX_GUARDEDALLOC
90 public:
91         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GHOST:GHOST_IEvent"); }
92         void operator delete( void *mem ) { MEM_freeN(mem); }
93 #endif
94 };
95
96 #endif // _GHOST_IEVENT_H_
97