Event.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 ROCKETCOREEVENT_H
00029 #define ROCKETCOREEVENT_H
00030 
00031 #include <Rocket/Core/Dictionary.h>
00032 #include <Rocket/Core/ScriptInterface.h>
00033 #include <Rocket/Core/Header.h>
00034 
00035 namespace Rocket {
00036 namespace Core {
00037 
00038 class Element;
00039 class EventInstancer;
00040 
00048 class ROCKETCORE_API Event : public ScriptInterface
00049 {
00050 public:
00052         Event();
00058         Event(Element* target, const String& type, const Dictionary& parameters, bool interruptible = false);
00060         virtual ~Event();
00061 
00062         enum EventPhase { PHASE_UNKNOWN, PHASE_CAPTURE, PHASE_TARGET, PHASE_BUBBLE };
00063 
00066         EventPhase GetPhase() const;
00069         void SetPhase(EventPhase phase);
00070 
00073         void SetCurrentElement(Element* element);
00076         Element* GetCurrentElement() const;
00077 
00080         Element* GetTargetElement() const;
00081 
00084         const String& GetType() const;
00088         bool operator==(const String& type) const;
00089 
00092         bool IsPropagating() const;
00094         void StopPropagation();
00095 
00099         template < typename T >
00100         T GetParameter(const String& key, const T& default_value)
00101         {
00102                 return parameters.Get(key, default_value);
00103         }
00106         const Dictionary* GetParameters() const;
00107 
00109         virtual void OnReferenceDeactivate();
00110 
00111 protected:
00112         String type;
00113         Dictionary parameters;
00114 
00115         Element* target_element;
00116         Element* current_element;
00117 
00118 private:
00119         bool interruptible;
00120         bool interruped;
00121 
00122         EventPhase phase;
00123 
00124         EventInstancer* instancer;
00125 
00126         friend class Factory;
00127 };
00128 
00129 }
00130 }
00131 
00132 #endif