GHOST_EventManager.h

Go to the documentation of this file.

/*
 * $Id: GHOST_EventManager.h 35152 2011-02-25 11:28:33Z jesterking $
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef _GHOST_EVENT_MANAGER_H_
#define _GHOST_EVENT_MANAGER_H_

#include <deque>
#include <vector>

#include "GHOST_IEventConsumer.h"


class GHOST_EventManager
{
public:
        GHOST_EventManager();

        virtual ~GHOST_EventManager();

        virtual GHOST_TUns32    getNumEvents();

        virtual GHOST_TUns32    getNumEvents(GHOST_TEventType type);

        virtual GHOST_IEvent* peekEvent();

        virtual GHOST_TSuccess pushEvent(GHOST_IEvent* event);

        virtual bool dispatchEvent(GHOST_IEvent* event);

        virtual bool dispatchEvent();

        virtual bool dispatchEvents();

        virtual GHOST_TSuccess addConsumer(GHOST_IEventConsumer* consumer);

        virtual GHOST_TSuccess removeConsumer(GHOST_IEventConsumer* consumer);

                virtual void
         removeWindowEvents(
                GHOST_IWindow* window
         );

                virtual void
        removeTypeEvents(
                GHOST_TEventType type,
                GHOST_IWindow* window = 0
        );

protected:
        virtual GHOST_IEvent* popEvent();

        virtual void disposeEvents();

        typedef std::deque<GHOST_IEvent*> TEventStack;
        
        std::deque<GHOST_IEvent*> m_events;

        typedef std::vector<GHOST_IEventConsumer*> TConsumerVector;

        TConsumerVector m_consumers;
};

#endif // _GHOST_EVENT_MANAGER_H_