Mercurial > fife-parpg
diff engine/core/eventchannel/base/ec_event.h @ 0:4a0efb7baf70
* Datasets becomes the new trunk and retires after that :-)
author | mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 |
---|---|
date | Sun, 29 Jun 2008 18:44:17 +0000 |
parents | |
children | 90005975cdbb |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/engine/core/eventchannel/base/ec_event.h Sun Jun 29 18:44:17 2008 +0000 @@ -0,0 +1,136 @@ +/*************************************************************************** + * Copyright (C) 2005-2008 by the FIFE team * + * http://www.fifengine.de * + * This file is part of FIFE. * + * * + * FIFE 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 St, Fifth Floor, Boston, MA 02110-1301 USA * + ***************************************************************************/ +/*************************************************************************** + * Note! FIFE event channel borrows heavily from ideas pf Guichan library * + * version 0.6 * + ***************************************************************************/ + + +#ifndef FIFE_EVENTCHANNEL_EVENT_H +#define FIFE_EVENTCHANNEL_EVENT_H + +// Standard C++ library includes +// +#include <string> +#include <sstream> + +// 3rd party library includes +// +#include <SDL.h> + +// FIFE includes +// These includes are split up in two parts, separated by one empty line +// First block: files included from the FIFE root src directory +// Second block: files included from the same folder +// +#include "eventchannel/source/ec_ieventsource.h" + +namespace gcn { + class Widget; +} + +namespace FIFE { + /** Base class for all events + */ + class Event { + public: + /** Constructor. + */ + Event(): + m_isconsumed(false), + m_eventsource(NULL), + m_timestamp(SDL_GetTicks()) {} + + /** Destructor. + */ + virtual ~Event() {} + + /** Marks the event as consumed. + */ + virtual void consume() { m_isconsumed = true; } + + /** Checks if the event is consumed. + * @return true if the event is consumed, false otherwise. + */ + virtual bool isConsumed() const { return m_isconsumed; } + + /** Gets the source of the event. + */ + virtual IEventSource* getSource() { return m_eventsource; } + + /** Sets the source of the event. + */ + virtual void setSource(IEventSource* source) { m_eventsource = source; } + + /** Get the source of the (widget) event. Null for non-widget. + * FIXME: This is a bit of a hack, using forward declared guichan pointer + * Should use something non-guichan specific + */ + virtual gcn::Widget* getSourceWidget() { return m_sourcewidget; } + + /** Set the source of the (widget) event. @see getSourceWidget + */ + virtual void setSourceWidget(gcn::Widget* widget) { m_sourcewidget = widget; } + + /** Gets the timestamp of the event + */ + virtual int getTimeStamp() const { return m_timestamp; } + + /** Sets the timestamp of the event + */ + virtual void setTimeStamp(int timestamp ) { m_timestamp = timestamp; } + + /** Gets the name of the event + */ + virtual const std::string& getName() const { + const static std::string eventName("Event"); + return eventName; + } + + /** Gets attribute string of the event + */ + virtual std::string getAttrStr() const { + std::stringstream ss; + ss << "consumed = " << m_isconsumed << ", "; + ss << "src = " << m_eventsource << ", "; + ss << "timestamp = " << m_timestamp; + return ss.str(); + } + + /** Gets the debugstring of the event + */ + virtual std::string getDebugString() const { + std::stringstream ss; + ss << getName() << std::endl; + ss << getAttrStr() << std::endl; + return ss.str(); + } + + private: + bool m_isconsumed; + IEventSource* m_eventsource; + gcn::Widget* m_sourcewidget; + int m_timestamp; + }; + +} //FIFE + +#endif