comparison engine/core/eventchannel/widget/ec_widgetevent.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
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /***************************************************************************
2 * Copyright (C) 2005-2008 by the FIFE team *
3 * http://www.fifengine.de *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_EVENTCHANNEL_WIDGETEVENT_H
23 #define FIFE_EVENTCHANNEL_WIDGETEVENT_H
24
25 // Standard C++ library includes
26 //
27
28 // 3rd party library includes
29 //
30
31 // FIFE includes
32 // These includes are split up in two parts, separated by one empty line
33 // First block: files included from the FIFE root src directory
34 // Second block: files included from the same folder
35 //
36 #include "eventchannel/base/ec_event.h"
37
38 namespace FIFE {
39 /** Interface for widget events
40 * Events are sent by different UI widgets
41 */
42 class WidgetEvent: public Event {
43 public:
44 /** Constructor.
45 */
46 WidgetEvent():
47 Event(),
48 m_id("") {}
49
50 /** Destructor.
51 */
52 ~WidgetEvent() {}
53
54 /**
55 * Gets the id of the event.
56 * @return the id of the event.
57 */
58 const std::string& getId() const { return m_id; }
59 void setId(const std::string& id) { m_id = id; }
60
61 virtual void consume() { Event::consume(); }
62 virtual bool isConsumed() const { return Event::isConsumed(); }
63 virtual IEventSource* getSource() { return Event::getSource(); }
64 virtual void setSource(IEventSource* source) { Event::setSource(source); }
65 virtual gcn::Widget* getSourceWidget() { return Event::getSourceWidget(); }
66 virtual void setSourceWidget(gcn::Widget* widget) { Event::setSourceWidget(widget); }
67 virtual int getTimeStamp() const { return Event::getTimeStamp(); }
68 virtual void setTimeStamp(int timestamp ) { Event::setTimeStamp(timestamp); }
69 virtual const std::string& getName() const {
70 const static std::string eventName("WidgetEvent");
71 return eventName;
72 }
73 virtual std::string getDebugString() const { return Event::getDebugString(); }
74
75 private:
76 std::string m_id;
77 };
78
79 } //FIFE
80
81 #endif