Yes I did it again ;)
[blender.git] / intern / ghost / intern / GHOST_EventManager.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 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  * @author      Maarten Gribnau
37  * @date        May 14, 2001
38  */
39
40 #ifndef _GHOST_EVENT_MANAGER_H_
41 #define _GHOST_EVENT_MANAGER_H_
42
43 #ifdef HAVE_CONFIG_H
44 #include <config.h>
45 #endif
46
47 #ifdef WIN32
48 #pragma warning (disable:4786) // suppress stl-MSVC debug info warning
49 #endif // WIN32
50
51 #include <deque>
52 #include <vector>
53
54 #include "GHOST_IEventConsumer.h"
55
56
57 /**
58  * Manages an event stack and a list of event consumers.
59  * The stack works on a FIFO (First In First Out) basis.
60  * Events are pushed on the front of the stack and retrieved from the back.
61  * Ownership of the event is transferred to the event manager as soon as an event is pushed.
62  * Ownership of the event is transferred from the event manager as soon as an event is popped.
63  * Events can be dispatched to the event consumers.
64  */
65 class GHOST_EventManager
66 {
67 public:
68         /**
69          * Constructor.
70          */
71         GHOST_EventManager();
72
73         /**
74          * Destructor.
75          */
76         virtual ~GHOST_EventManager();
77
78         /**
79          * Returns the number of events currently on the stack.
80          * @return The number of events on the stack.
81          */
82         virtual GHOST_TUns32    getNumEvents();
83
84         /**
85          * Returns the number of events of a certain type currently on the stack.
86          * @param type The type of events to be counted.
87          * @return The number of events on the stack of this type.
88          */
89         virtual GHOST_TUns32    getNumEvents(GHOST_TEventType type);
90
91         /**
92          * Return the event at the top of the stack without removal.
93          * Do not delete the event!
94          * @return The event at the top of the stack.
95          */
96         virtual GHOST_IEvent* peekEvent();
97
98         /**
99          * Pushes an event on the stack.
100          * To dispatch it, call dispatchEvent() or dispatchEvents().
101          * Do not delete the event!
102          * @param event The event to push on the stack.
103          */
104         virtual GHOST_TSuccess pushEvent(GHOST_IEvent* event);
105
106         /**
107          * Dispatches the given event directly, bypassing the event stack.
108          * @return Indication as to whether any of the consumers handled the event.
109          */
110         virtual bool dispatchEvent(GHOST_IEvent* event);
111
112         /**
113          * Dispatches the event at the back of the stack.
114          * The event will be removed from the stack.
115          * @return Indication as to whether any of the consumers handled the event.
116          */
117         virtual bool dispatchEvent();
118
119         /**
120          * Dispatches all the events on the stack.
121          * The event stack will be empty afterwards.
122          * @return Indication as to whether any of the consumers handled the events.
123          */
124         virtual bool dispatchEvents();
125
126         /**
127          * Adds a consumer to the list of event consumers.
128          * @param consumer The consumer added to the list.
129          * @return Indication as to whether addition has succeeded.
130          */
131         virtual GHOST_TSuccess addConsumer(GHOST_IEventConsumer* consumer);
132
133         /**
134          * Removes a consumer from the list of event consumers.
135          * @param consumer The consumer removed from the list.
136          * @return Indication as to whether removal has succeeded.
137          */
138         virtual GHOST_TSuccess removeConsumer(GHOST_IEventConsumer* consumer);
139
140 protected:
141         /**
142          * Returns the event at the top of the stack and removes it.
143          * Delete the event after use!
144          * @return The event at the top of the stack.
145          */
146         virtual GHOST_IEvent* popEvent();
147
148         /**
149          * Removes all events from the stack.
150          */
151         virtual void disposeEvents();
152
153         /** The event stack. */
154         std::deque<GHOST_IEvent*> m_events;
155
156         typedef std::vector<GHOST_IEventConsumer*> TConsumerVector;
157         /** The list with event consumers. */
158         TConsumerVector m_consumers;
159 };
160
161 #endif // _GHOST_EVENT_MANAGER_H_
162