Crazy Eddie's GUI System  0.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
EventLinkDefinition.h
1 /***********************************************************************
2  filename: CEGUIEventLinkDefinition.h
3  created: Sun Nov 21 2010
4  author: Paul D Turner <paul@cegui.org.uk>
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2010 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 _CEGUIFalEventLinkDefinition_h_
29 #define _CEGUIFalEventLinkDefinition_h_
30 
31 #include "../String.h"
32 #include "../IteratorBase.h"
33 
34 #include <vector>
35 
36 #if defined(_MSC_VER)
37 # pragma warning(push)
38 # pragma warning(disable : 4251)
39 #endif
40 
41 // Start of CEGUI namespace section
42 namespace CEGUI
43 {
44 class CEGUIEXPORT EventLinkDefinition :
45  public AllocatedObject<EventLinkDefinition>
46 {
47 public:
48  EventLinkDefinition(const String& event_name);
50 
52  void addLinkTarget(const String& widget, const String& event);
54  void clearLinkTargets();
55 
57  void initialiseWidget(Window& window) const;
58 
60  void cleanUpWidget(Window& window) const;
61 
62 
63  void setName(const String& name);
65  const String& getName() const;
66 
67 protected:
69  Window* getTargetWindow(Window& start_wnd,
70  const String& name) const;
71 
74 
75  typedef std::pair<String,String> StringPair;
77  typedef std::vector<StringPair CEGUI_VECTOR_ALLOC(StringPair)> LinkTargetCollection;
78 
81 public:
83  LinkTargetIterator getLinkTargetIterator() const;
84 };
85 
86 } // End of CEGUI namespace section
87 
88 #if defined(_MSC_VER)
89 # pragma warning(pop)
90 #endif
91 
92 #endif // end of guard _CEGUIFalEventLinkDefinition_h_
93