Patch from GSR that a) fixes a whole bunch of GPL/BL license
[blender.git] / intern / ghost / intern / GHOST_EventManager.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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_EventManager.h
30  * Declaration of GHOST_EventManager class.
31  */
32
33 #ifndef _GHOST_EVENT_MANAGER_H_
34 #define _GHOST_EVENT_MANAGER_H_
35
36 #ifdef WIN32
37 #pragma warning (disable:4786) // suppress stl-MSVC debug info warning
38 #endif // WIN32
39
40 #include <deque>
41 #include <vector>
42
43 #include "GHOST_IEventConsumer.h"
44
45
46 /**
47  * Manages an event stack and a list of event consumers.
48  * The stack works on a FIFO (First In First Out) basis.
49  * Events are pushed on the front of the stack and retrieved from the back.
50  * Ownership of the event is transferred to the event manager as soon as an event is pushed.
51  * Ownership of the event is transferred from the event manager as soon as an event is popped.
52  * Events can be dispatched to the event consumers.
53  */
54 class GHOST_EventManager
55 {
56 public:
57         /**
58          * Constructor.
59          */
60         GHOST_EventManager();
61
62         /**
63          * Destructor.
64          */
65         virtual ~GHOST_EventManager();
66
67         /**
68          * Returns the number of events currently on the stack.
69          * @return The number of events on the stack.
70          */
71         virtual GHOST_TUns32    getNumEvents();
72
73         /**
74          * Returns the number of events of a certain type currently on the stack.
75          * @param type The type of events to be counted.
76          * @return The number of events on the stack of this type.
77          */
78         virtual GHOST_TUns32    getNumEvents(GHOST_TEventType type);
79
80         /**
81          * Return the event at the top of the stack without removal.
82          * Do not delete the event!
83          * @return The event at the top of the stack.
84          */
85         virtual GHOST_IEvent* peekEvent();
86
87         /**
88          * Pushes an event on the stack.
89          * To dispatch it, call dispatchEvent() or dispatchEvents().
90          * Do not delete the event!
91          * @param event The event to push on the stack.
92          */
93         virtual GHOST_TSuccess pushEvent(GHOST_IEvent* event);
94
95         /**
96          * Dispatches the given event directly, bypassing the event stack.
97          * @return Indication as to whether any of the consumers handled the event.
98          */
99         virtual bool dispatchEvent(GHOST_IEvent* event);
100
101         /**
102          * Dispatches the event at the back of the stack.
103          * The event will be removed from the stack.
104          * @return Indication as to whether any of the consumers handled the event.
105          */
106         virtual bool dispatchEvent();
107
108         /**
109          * Dispatches all the events on the stack.
110          * The event stack will be empty afterwards.
111          * @return Indication as to whether any of the consumers handled the events.
112          */
113         virtual bool dispatchEvents();
114
115         /**
116          * Adds a consumer to the list of event consumers.
117          * @param consumer The consumer added to the list.
118          * @return Indication as to whether addition has succeeded.
119          */
120         virtual GHOST_TSuccess addConsumer(GHOST_IEventConsumer* consumer);
121
122         /**
123          * Removes a consumer from the list of event consumers.
124          * @param consumer The consumer removed from the list.
125          * @return Indication as to whether removal has succeeded.
126          */
127         virtual GHOST_TSuccess removeConsumer(GHOST_IEventConsumer* consumer);
128
129         /**
130          * Removes all events for a window from the stack.
131          * @param       window  The window to remove events for.
132          */
133                 virtual void
134          removeWindowEvents(
135                 GHOST_IWindow* window
136          );
137
138         /**
139          * Removes all events of a certain type from the stack.
140          * The window parameter is optional. If non-null, the routine will remove
141          * events only associated with that window.
142          * @param       type    The type of events to be removed.
143          * @param       window  The window to remove the events for.
144          */
145                 virtual void
146         removeTypeEvents(
147                 GHOST_TEventType type,
148                 GHOST_IWindow* window = 0
149         );
150
151 protected:
152         /**
153          * Returns the event at the top of the stack and removes it.
154          * Delete the event after use!
155          * @return The event at the top of the stack.
156          */
157         virtual GHOST_IEvent* popEvent();
158
159         /**
160          * Removes all events from the stack.
161          */
162         virtual void disposeEvents();
163
164         /** A stack with events. */
165         typedef std::deque<GHOST_IEvent*> TEventStack;
166         
167         /** The event stack. */
168         std::deque<GHOST_IEvent*> m_events;
169
170         /** A vector with event consumers. */
171         typedef std::vector<GHOST_IEventConsumer*> TConsumerVector;
172
173         /** The list with event consumers. */
174         TConsumerVector m_consumers;
175 };
176
177 #endif // _GHOST_EVENT_MANAGER_H_
178