Crazy Eddies GUI System 0.7.6
CEGUISubscriberSlot.h
00001 /************************************************************************
00002     filename:   CEGUISubscriberSlot.h
00003     created:    Tue Feb 28 2006
00004     author:     Paul D Turner <paul@cegui.org.uk>
00005 *************************************************************************/
00006 /***************************************************************************
00007  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
00008  *
00009  *   Permission is hereby granted, free of charge, to any person obtaining
00010  *   a copy of this software and associated documentation files (the
00011  *   "Software"), to deal in the Software without restriction, including
00012  *   without limitation the rights to use, copy, modify, merge, publish,
00013  *   distribute, sublicense, and/or sell copies of the Software, and to
00014  *   permit persons to whom the Software is furnished to do so, subject to
00015  *   the following conditions:
00016  *
00017  *   The above copyright notice and this permission notice shall be
00018  *   included in all copies or substantial portions of the Software.
00019  *
00020  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00021  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00022  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00023  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00024  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00025  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00026  *   OTHER DEALINGS IN THE SOFTWARE.
00027  ***************************************************************************/
00028 #ifndef _CEGUISubscriberSlot_h_
00029 #define _CEGUISubscriberSlot_h_
00030 
00031 #include "CEGUIBase.h"
00032 #include "CEGUIFreeFunctionSlot.h"
00033 #include "CEGUIFunctorCopySlot.h"
00034 #include "CEGUIFunctorReferenceSlot.h"
00035 #include "CEGUIFunctorPointerSlot.h"
00036 #include "CEGUIMemberFunctionSlot.h"
00037 #include "CEGUIFunctorReferenceBinder.h"
00038 
00039 // Start of CEGUI namespace section
00040 namespace CEGUI
00041 {
00042 
00052 class CEGUIEXPORT SubscriberSlot
00053 {
00054 public:
00059     SubscriberSlot();
00060 
00065     SubscriberSlot(FreeFunctionSlot::SlotFunction* func);
00066 
00072     ~SubscriberSlot();
00073 
00080     bool operator()(const EventArgs& args) const
00081     {
00082         return (*d_functor_impl)(args);
00083     }
00084 
00089     bool connected() const
00090     {
00091         return d_functor_impl != 0;
00092     }
00093 
00099     void cleanup();
00100 
00101     // templatised constructors
00106     template<typename T>
00107     SubscriberSlot(bool (T::*function)(const EventArgs&), T* obj) :
00108         d_functor_impl(new MemberFunctionSlot<T>(function, obj))
00109     {}
00110 
00115     template<typename T>
00116     SubscriberSlot(const FunctorReferenceBinder<T>& binder) :
00117         d_functor_impl(new FunctorReferenceSlot<T>(binder.d_functor))
00118     {}
00119 
00124     template<typename T>
00125     SubscriberSlot(const T& functor) :
00126         d_functor_impl(new FunctorCopySlot<T>(functor))
00127     {}
00128 
00133     template<typename T>
00134     SubscriberSlot(T* functor) :
00135         d_functor_impl(new FunctorPointerSlot<T>(functor))
00136     {}
00137 
00138 private:
00140     SlotFunctorBase* d_functor_impl;
00141 };
00142 
00143 } // End of  CEGUI namespace section
00144 
00145 #endif  // end of guard _CEGUISubscriberSlot_h_