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