SubscriberSlot.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 _CEGUISubscriberSlot_h_
#define _CEGUISubscriberSlot_h_

#include "CEGUI/Base.h"
#include "CEGUI/FreeFunctionSlot.h"
#include "CEGUI/FunctorCopySlot.h"
#include "CEGUI/FunctorReferenceSlot.h"
#include "CEGUI/FunctorPointerSlot.h"
#include "CEGUI/MemberFunctionSlot.h"
#include "CEGUI/FunctorReferenceBinder.h"

// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT SubscriberSlot :
    public AllocatedObject<SubscriberSlot>
{
public:
    SubscriberSlot();

    SubscriberSlot(FreeFunctionSlot::SlotFunction* func);

    ~SubscriberSlot();

    bool operator()(const EventArgs& args) const
    {
        return (*d_functor_impl)(args);
    }

    bool connected() const
    {
        return d_functor_impl != 0;
    }

    void cleanup();

    // templatised constructors
    template<typename T>
    SubscriberSlot(bool (T::*function)(const EventArgs&), T* obj) :
        d_functor_impl(new MemberFunctionSlot<T>(function, obj))
    {}

    template<typename T>
    SubscriberSlot(const FunctorReferenceBinder<T>& binder) :
        d_functor_impl(new FunctorReferenceSlot<T>(binder.d_functor))
    {}

    template<typename T>
    SubscriberSlot(const T& functor) :
        d_functor_impl(new FunctorCopySlot<T>(functor))
    {}

    template<typename T>
    SubscriberSlot(T* functor) :
        d_functor_impl(new FunctorPointerSlot<T>(functor))
    {}

private:
    SlotFunctorBase* d_functor_impl;
};

} // End of  CEGUI namespace section

#endif  // end of guard _CEGUISubscriberSlot_h_