Event.h

/************************************************************************
    filename:   CEGUIEvent.h
    created:    Tue Feb 28 2006
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2010 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 _CEGUIEvent_h_
#define _CEGUIEvent_h_

#include "CEGUI/String.h"
#include "CEGUI/BoundSlot.h"
#include "CEGUI/SubscriberSlot.h"
#include "CEGUI/RefCounted.h"

#include <map>

#if defined(_MSC_VER)
#   pragma warning(push)
#   pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT Event :
    public AllocatedObject<Event>
{
public:
    typedef RefCounted<BoundSlot> Connection;

    typedef CEGUI::SubscriberSlot Subscriber;

    typedef unsigned int Group;

    class ScopedConnection : public Connection
    {
    public:
        ScopedConnection() {}

        ~ScopedConnection()
        {
            disconnect();
        }

        ScopedConnection(const Event::Connection& connection) :
            d_connection(connection)
        {}

        ScopedConnection& operator=(const Event::Connection& connection)
        {
            d_connection = connection;
            return *this;
        }

        bool connected() const
        {
            return d_connection.isValid() ? d_connection->connected() : false;
        }

        void disconnect()
        {
            if (d_connection.isValid()) d_connection->disconnect();
        }

    private:
        Event::Connection d_connection;
    };

    Event(const String& name);

    virtual ~Event();

    const String& getName(void) const
    {
        return d_name;
    }

    Connection subscribe(const Subscriber& slot);

    Connection subscribe(Group group, const Subscriber& slot);

    void operator()(EventArgs& args);


protected:
    friend void CEGUI::BoundSlot::disconnect();
    void unsubscribe(const BoundSlot& slot);

    // Copy constructor and assignment are not allowed for events
    Event(const Event&) {}
    Event& operator=(const Event&)
    {
        return *this;
    }

    typedef std::multimap<Group, Connection, std::less<Group>
        CEGUI_MULTIMAP_ALLOC(Group, Connection)> SlotContainer;
    SlotContainer d_slots;  
    const String d_name;    
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#   pragma warning(pop)
#endif

#endif  // end of guard _CEGUIEvent_h_