BoundSlot.h

/************************************************************************
    filename:   CEGUIBoundSlot.h
    created:    Tue Feb 28 2006
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIBoundSlot_h_
#define _CEGUIBoundSlot_h_

#include "CEGUI/Base.h"
#include "CEGUI/SubscriberSlot.h"

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT BoundSlot :
    public AllocatedObject<BoundSlot>
{
public:
    typedef unsigned int Group;

    BoundSlot(Group group, const SubscriberSlot& subscriber, Event& event);

    BoundSlot(const BoundSlot& other);

    ~BoundSlot();

    bool connected() const;

    void disconnect();

    bool operator==(const BoundSlot& other) const;

    bool operator!=(const BoundSlot& other) const;

private:
    friend class Event;
    // no assignment.
    BoundSlot& operator=(const BoundSlot& other);
    Group d_group;                  
    SubscriberSlot* d_subscriber;   
    Event* d_event;                 
};

} // End of  CEGUI namespace section

#endif  // end of guard _CEGUIBoundSlot_h_