Crazy Eddie's GUI System 0.8.7
LinkedEvent.h
1/***********************************************************************
2 created: Sun Nov 21 2010
3 author: Paul D Turner <paul@cegui.org.uk>
4*************************************************************************/
5/***************************************************************************
6 * Copyright (C) 2004 - 2010 Paul D Turner & The CEGUI Development Team
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining
9 * a copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sublicense, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be
17 * included in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 * OTHER DEALINGS IN THE SOFTWARE.
26 ***************************************************************************/
27#ifndef _CEGUILinkedEvent_h_
28#define _CEGUILinkedEvent_h_
29
30#include "CEGUI/Event.h"
31#include <vector>
32
33#if defined(_MSC_VER)
34# pragma warning(push)
35# pragma warning(disable : 4251)
36#endif
37
38// Start of CEGUI namespace section
39namespace CEGUI
40{
41
53class CEGUIEXPORT LinkedEvent : public Event
54{
55public:
66 LinkedEvent(const String& event_name, EventSet* target_event_set);
68
82 void addLinkedTarget(Event& link_target);
83
84protected:
85 bool handler(const EventArgs& args);
86
87 LinkedEvent(const LinkedEvent& e) : Event(e) {}
88
89 typedef std::vector<Event::Connection
90 CEGUI_VECTOR_ALLOC(Event::Connection)> LinkedConnections;
92 LinkedConnections d_connections;
95};
96
97} // End of CEGUI namespace section
98
99#if defined(_MSC_VER)
100# pragma warning(pop)
101#endif
102
103#endif // end of guard _CEGUILinkedEvent_h_
104
Base class used as the argument to all subscribers Event object.
Definition: EventArgs.h:51
Interface providing event signaling and handling.
Definition: EventSet.h:167
Defines an 'event' which can be subscribed to by interested parties.
Definition: Event.h:59
LinkedEvent is an Event subclass that provides a mechanism to link or chain Events together,...
Definition: LinkedEvent.h:54
LinkedConnections d_connections
collection of connection to the linked Events.
Definition: LinkedEvent.h:92
const EventSet * d_owner
reference to the event set that we added ourself to
Definition: LinkedEvent.h:94
LinkedEvent(const String &event_name, EventSet *target_event_set)
Constructor.
void addLinkedTarget(Event &link_target)
Add a link target for this event. A link target is an event that will trigger this event.
String class used within the GUI system.
Definition: String.h:64
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1