Crazy Eddie's GUI System 0.8.7
EventAction.h
1/***********************************************************************
2 created: Fri Mar 02 2012
3 author: Paul D Turner <paul@cegui.org.uk>
4*************************************************************************/
5/***************************************************************************
6 * Copyright (C) 2004 - 2012 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 _CEGUIEventAction_h_
28#define _CEGUIEventAction_h_
29
30#include "CEGUI/String.h"
31#include "CEGUI/Event.h"
32#include "CEGUI/falagard/Enums.h"
33
34#include <map>
35
36#if defined (_MSC_VER)
37# pragma warning(push)
38# pragma warning(disable : 4251)
39#endif
40
41namespace CEGUI
42{
43class Window;
44
45class CEGUIEXPORT EventAction :
46 public AllocatedObject<EventAction>
47{
48public:
49 EventAction(const String& event_name, ChildEventAction action);
51
52 void setEventName(const String& event_name);
53 const String& getEventName() const;
54
55 void setAction(ChildEventAction action);
56 ChildEventAction getAction() const;
57
58 void initialiseWidget(Window& widget) const;
59 void cleanupWidget(Window& widget) const;
60
61 void writeXMLToStream(XMLSerializer& xml_stream) const;
62
63protected:
64 String d_eventName;
65 ChildEventAction d_action;
66
67 String makeConnectionKeyName(const Window& widget) const;
68
70 CEGUI_MULTIMAP_ALLOC(String, Event::ScopedConnection)> ConnectionMap;
71 mutable ConnectionMap d_connections;
72};
73
74}
75
76#if defined(_MSC_VER)
77# pragma warning(pop)
78#endif
79
80#endif
81
Definition: MemoryAllocatedObject.h:110
Definition: EventAction.h:47
Event::Connection wrapper that automatically disconnects the connection when the object is deleted (o...
Definition: Event.h:92
String class used within the GUI system.
Definition: String.h:64
An abstract base class providing common functionality and specifying the required interface for deriv...
Definition: Window.h:151
Class used to create XML Document.
Definition: XMLSerializer.h:87
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
ChildEventAction
Enumeration of actions a WidgetLook can take in response to some event firing on a child WidgetCompon...
Definition: Enums.h:155
Functor that can be used as comparator in a std::map with String keys. It's faster than using the def...
Definition: String.h:5580