Crazy Eddie's GUI System 0.8.7
Loading...
Searching...
No Matches
BoundSlot.h
1/************************************************************************
2 created: Tue Feb 28 2006
3 author: Paul D Turner <paul@cegui.org.uk>
4*************************************************************************/
5/***************************************************************************
6 * Copyright (C) 2004 - 2006 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 _CEGUIBoundSlot_h_
28#define _CEGUIBoundSlot_h_
29
30#include "CEGUI/Base.h"
31#include "CEGUI/SubscriberSlot.h"
32
33// Start of CEGUI namespace section
34namespace CEGUI
35{
44class CEGUIEXPORT BoundSlot :
45 public AllocatedObject<BoundSlot>
46{
47public:
48 typedef unsigned int Group;
49
63 BoundSlot(Group group, const SubscriberSlot& subscriber, Event& event);
64
69 BoundSlot(const BoundSlot& other);
70
76
86 bool connected() const;
87
98 void disconnect();
99
111 bool operator==(const BoundSlot& other) const;
112
124 bool operator!=(const BoundSlot& other) const;
125
126private:
127 friend class Event;
128 // no assignment.
129 BoundSlot& operator=(const BoundSlot& other);
130 Group d_group;
131 SubscriberSlot* d_subscriber;
132 Event* d_event;
133};
134
135} // End of CEGUI namespace section
136
137#endif // end of guard _CEGUIBoundSlot_h_
Definition MemoryAllocatedObject.h:110
Class that tracks a SubscriberSlot, its group, and the Event to which it was subscribed....
Definition BoundSlot.h:46
bool operator==(const BoundSlot &other) const
Equality operator.
bool connected() const
Returns whether the slot which this object is tracking is still internally connected to the signal / ...
BoundSlot(Group group, const SubscriberSlot &subscriber, Event &event)
Constructor.
bool operator!=(const BoundSlot &other) const
Non-equality operator.
void disconnect()
Disconnects the slot. Once disconnected, the slot will no longer be called when the associated signal...
~BoundSlot()
Destructor.
BoundSlot(const BoundSlot &other)
Copy constructor.
Defines an 'event' which can be subscribed to by interested parties.
Definition Event.h:59
SubscriberSlot class which is used when subscribing to events.
Definition SubscriberSlot.h:53
Main namespace for Crazy Eddie's GUI Library.
Definition arch_overview.dox:1