== SCons ==
[blender.git] / intern / ghost / GHOST_IEvent.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL 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. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31 /**
32  * @file        GHOST_IEvent.h
33  * Declaration of GHOST_IEvent interface class.
34  */
35
36 #ifndef _GHOST_IEVENT_H_
37 #define _GHOST_IEVENT_H_
38
39 #include "GHOST_Types.h"
40
41 class GHOST_IWindow;
42
43 /**
44  * Interface class for events received from GHOST.
45  * You should not need to inherit this class. The system will pass these events
46  * to the GHOST_IEventConsumer::processEvent() method of event consumers.<br>
47  * Use the getType() method to retrieve the type of event and the getData() 
48  * method to get the event data out. Using the event type you can cast the 
49  * event data to the correct event dat structure.
50  * @see GHOST_IEventConsumer#processEvent
51  * @see GHOST_TEventType
52  * @author      Maarten Gribnau
53  * @date        May 31, 2001
54  */
55 class GHOST_IEvent
56 {
57 public:
58         /**
59          * Destructor.
60          */
61         virtual ~GHOST_IEvent()
62         {
63         }
64
65         /**
66          * Returns the event type.
67          * @return The event type.
68          */
69         virtual GHOST_TEventType getType() = 0;
70
71         /**
72          * Returns the time this event was generated.
73          * @return The event generation time.
74          */
75         virtual GHOST_TUns64 getTime() = 0;
76
77         /**
78          * Returns the window this event was generated on, 
79          * or NULL if it is a 'system' event.
80          * @return The generating window.
81          */
82         virtual GHOST_IWindow* getWindow() = 0;
83         
84         /**
85          * Returns the event data.
86          * @return The event data.
87          */
88         virtual GHOST_TEventDataPtr getData() = 0;
89 };
90
91 #endif // _GHOST_IEVENT_H_
92