EventDispatcher.h

00001 /*
00002  * This source file is part of libRocket, the HTML/CSS Interface Middleware
00003  *
00004  * For the latest information, see http://www.librocket.com
00005  *
00006  * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
00007  *
00008  * Permission is hereby granted, free of charge, to any person obtaining a copy
00009  * of this software and associated documentation files (the "Software"), to deal
00010  * in the Software without restriction, including without limitation the rights
00011  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012  * copies of the Software, and to permit persons to whom the Software is
00013  * furnished to do so, subject to the following conditions:
00014  *
00015  * The above copyright notice and this permission notice shall be included in
00016  * all copies or substantial portions of the Software.
00017  * 
00018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024  * THE SOFTWARE.
00025  *
00026  */
00027 
00028 #ifndef ROCKETCOREEVENTDISPATCHER_H
00029 #define ROCKETCOREEVENTDISPATCHER_H
00030 
00031 #include <Rocket/Core/String.h>
00032 #include <Rocket/Core/Event.h>
00033 #include <map>
00034 
00035 namespace Rocket {
00036 namespace Core {
00037 
00038 class Element;
00039 class EventListener;
00040 
00048 class EventDispatcher 
00049 {
00050 public:
00053         EventDispatcher(Element* element);
00054 
00055         // Destructor
00056         ~EventDispatcher();
00057 
00062         void AttachEvent(const String& type, EventListener* event_listener, bool in_capture_phase);
00063 
00068         void DetachEvent(const String& type, EventListener* listener, bool in_capture_phase);
00069 
00071         void DetachAllEvents();
00072 
00079         bool DispatchEvent(Element* element, const String& name, const Dictionary& parameters, bool interruptible);
00080 
00081 private:
00082         Element* element;
00083 
00084         struct Listener
00085         {
00086                 Listener(EventListener* _listener, bool _in_capture_phase) : listener(_listener), in_capture_phase(_in_capture_phase) {}
00087                 EventListener* listener;
00088                 bool in_capture_phase;
00089         };
00090         typedef std::vector< Listener > Listeners;
00091         typedef std::map< String, Listeners > Events;
00092         Events events;
00093 
00094         void TriggerEvents(Event* event);
00095 };
00096 
00097 }
00098 }
00099 
00100 #endif