Blender
V3.3
|
#include <GHOST_EventManager.h>
Public Member Functions | |
GHOST_EventManager () | |
~GHOST_EventManager () | |
uint32_t | getNumEvents () |
uint32_t | getNumEvents (GHOST_TEventType type) |
GHOST_TSuccess | pushEvent (GHOST_IEvent *event) |
void | dispatchEvent (GHOST_IEvent *event) |
void | dispatchEvent () |
void | dispatchEvents () |
GHOST_TSuccess | addConsumer (GHOST_IEventConsumer *consumer) |
GHOST_TSuccess | removeConsumer (GHOST_IEventConsumer *consumer) |
void | removeWindowEvents (GHOST_IWindow *window) |
void | removeTypeEvents (GHOST_TEventType type, GHOST_IWindow *window=NULL) |
Protected Types | |
typedef std::deque< GHOST_IEvent * > | TEventStack |
typedef std::vector< GHOST_IEventConsumer * > | TConsumerVector |
Protected Member Functions | |
void | disposeEvents () |
Protected Attributes | |
std::deque< GHOST_IEvent * > | m_events |
std::deque< GHOST_IEvent * > | m_handled_events |
TConsumerVector | m_consumers |
Manages an event stack and a list of event consumers. The stack works on a FIFO (First In First Out) basis. Events are pushed on the front of the stack and retrieved from the back. Ownership of the event is transferred to the event manager as soon as an event is pushed. Ownership of the event is transferred from the event manager as soon as an event is popped. Events can be dispatched to the event consumers.
Definition at line 24 of file GHOST_EventManager.h.
|
protected |
A vector with event consumers.
Definition at line 117 of file GHOST_EventManager.h.
|
protected |
A stack with events.
Definition at line 110 of file GHOST_EventManager.h.
GHOST_EventManager::GHOST_EventManager | ( | ) |
Constructor.
Copyright (C) 2001 NaN Technologies B.V.
Definition at line 16 of file GHOST_EventManager.cpp.
GHOST_EventManager::~GHOST_EventManager | ( | ) |
Destructor.
Definition at line 20 of file GHOST_EventManager.cpp.
References disposeEvents(), and m_consumers.
GHOST_TSuccess GHOST_EventManager::addConsumer | ( | GHOST_IEventConsumer * | consumer | ) |
Adds a consumer to the list of event consumers.
consumer | The consumer added to the list. |
Definition at line 90 of file GHOST_EventManager.cpp.
References GHOST_ASSERT, GHOST_kFailure, GHOST_kSuccess, and m_consumers.
Referenced by GHOST_System::addEventConsumer(), and GHOST_System::init().
void GHOST_EventManager::dispatchEvent | ( | ) |
Dispatches the event at the back of the stack. The event will be removed from the stack.
Definition at line 72 of file GHOST_EventManager.cpp.
References m_events, and m_handled_events.
Referenced by dispatchEvents().
void GHOST_EventManager::dispatchEvent | ( | GHOST_IEvent * | event | ) |
Dispatches the given event directly, bypassing the event stack.
Definition at line 63 of file GHOST_EventManager.cpp.
References m_consumers.
void GHOST_EventManager::dispatchEvents | ( | ) |
Dispatches all the events on the stack. The event stack will be empty afterwards.
Definition at line 81 of file GHOST_EventManager.cpp.
References dispatchEvent(), disposeEvents(), and m_events.
Referenced by GHOST_System::dispatchEvents().
|
protected |
Removes all events from the stack.
Definition at line 173 of file GHOST_EventManager.cpp.
References GHOST_ASSERT, m_events, and m_handled_events.
Referenced by dispatchEvents(), and ~GHOST_EventManager().
uint32_t GHOST_EventManager::getNumEvents | ( | ) |
Returns the number of events currently on the stack.
Definition at line 32 of file GHOST_EventManager.cpp.
References m_events.
Referenced by GHOST_SystemWin32::processEvents(), and GHOST_SystemWayland::processEvents().
uint32_t GHOST_EventManager::getNumEvents | ( | GHOST_TEventType | type | ) |
Returns the number of events of a certain type currently on the stack.
type | The type of events to be counted. |
Definition at line 37 of file GHOST_EventManager.cpp.
GHOST_TSuccess GHOST_EventManager::pushEvent | ( | GHOST_IEvent * | event | ) |
Pushes an event on the stack. To dispatch it, call dispatchEvent() or dispatchEvents(). Do not delete the event!
event | The event to push on the stack. |
Definition at line 49 of file GHOST_EventManager.cpp.
References GHOST_ASSERT, GHOST_kFailure, GHOST_kSuccess, and m_events.
Referenced by GHOST_System::pushEvent().
GHOST_TSuccess GHOST_EventManager::removeConsumer | ( | GHOST_IEventConsumer * | consumer | ) |
Removes a consumer from the list of event consumers.
consumer | The consumer removed from the list. |
Definition at line 110 of file GHOST_EventManager.cpp.
References GHOST_ASSERT, GHOST_kFailure, GHOST_kSuccess, and m_consumers.
Referenced by GHOST_System::removeEventConsumer().
void GHOST_EventManager::removeTypeEvents | ( | GHOST_TEventType | type, |
GHOST_IWindow * | window = NULL |
||
) |
Removes all events of a certain type from the stack. The window parameter is optional. If non-null, the routine will remove events only associated with that window.
type | The type of events to be removed. |
window | The window to remove the events for. |
Definition at line 151 of file GHOST_EventManager.cpp.
References GHOST_PRINT, m_events, and type.
Referenced by GHOST_SystemWin32::s_wndProc().
void GHOST_EventManager::removeWindowEvents | ( | GHOST_IWindow * | window | ) |
Removes all events for a window from the stack.
window | The window to remove events for. |
Definition at line 129 of file GHOST_EventManager.cpp.
References GHOST_PRINT, and m_events.
Referenced by GHOST_System::disposeWindow().
|
protected |
The list with event consumers.
Definition at line 120 of file GHOST_EventManager.h.
Referenced by addConsumer(), dispatchEvent(), removeConsumer(), and ~GHOST_EventManager().
|
protected |
The event stack.
Definition at line 113 of file GHOST_EventManager.h.
Referenced by dispatchEvent(), dispatchEvents(), disposeEvents(), getNumEvents(), pushEvent(), removeTypeEvents(), and removeWindowEvents().
|
protected |
Definition at line 114 of file GHOST_EventManager.h.
Referenced by dispatchEvent(), and disposeEvents().