Crazy Eddie's GUI System  0.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
EventAction.h
1 /***********************************************************************
2  filename: EventAction.h
3  created: Fri Mar 02 2012
4  author: Paul D Turner <paul@cegui.org.uk>
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2012 Paul D Turner & The CEGUI Development Team
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining
10  * a copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26  * OTHER DEALINGS IN THE SOFTWARE.
27  ***************************************************************************/
28 #ifndef _CEGUIEventAction_h_
29 #define _CEGUIEventAction_h_
30 
31 #include "CEGUI/String.h"
32 #include "CEGUI/Event.h"
33 #include "CEGUI/falagard/Enums.h"
34 
35 #include <map>
36 
37 #if defined (_MSC_VER)
38 # pragma warning(push)
39 # pragma warning(disable : 4251)
40 #endif
41 
42 namespace CEGUI
43 {
44 class Window;
45 
46 class CEGUIEXPORT EventAction :
47  public AllocatedObject<EventAction>
48 {
49 public:
50  EventAction(const String& event_name, ChildEventAction action);
51  ~EventAction();
52 
53  void setEventName(const String& event_name);
54  const String& getEventName() const;
55 
56  void setAction(ChildEventAction action);
57  ChildEventAction getAction() const;
58 
59  void initialiseWidget(Window& widget) const;
60  void cleanupWidget(Window& widget) const;
61 
62  void writeXMLToStream(XMLSerializer& xml_stream) const;
63 
64 protected:
65  String d_eventName;
66  ChildEventAction d_action;
67 
68  String makeConnectionKeyName(const Window& widget) const;
69 
70  typedef std::multimap<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