X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;ds=sidebyside;f=dali%2Fpublic-api%2Fsignals%2Ffunctor-delegate.h;h=60c6795979216b5b7b825c3dda91b5148b46cfb0;hb=refs%2Fchanges%2F57%2F114957%2F2;hp=c2564dab4e9ef86e54795ec6b688cfd6be0cee3f;hpb=07d00b695a47b884599de3a9aaf36eba21a3f827;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/signals/functor-delegate.h b/dali/public-api/signals/functor-delegate.h index c2564da..60c6795 100644 --- a/dali/public-api/signals/functor-delegate.h +++ b/dali/public-api/signals/functor-delegate.h @@ -29,15 +29,17 @@ namespace Dali */ /** - * @brief Dispatcher to call a functor + * @brief Dispatcher to call a functor. + * @SINCE_1_0.0 */ template< typename T > struct FunctorDispatcher { /** - * @brief Call a function object. + * @brief Calls a function object. * - * @param[in] functorPtr The functor to call. + * @SINCE_1_0.0 + * @param[in] functorPtr The functor to call */ static void Dispatch( void* functorPtr ) { @@ -48,13 +50,16 @@ struct FunctorDispatcher }; /** - * @brief Dispatcher to delete a functor object + * @brief Dispatcher to delete a functor object. + * @SINCE_1_0.0 */ template< typename T > struct FunctorDestroyer { /** - * @brief Dispatcher to delete an object + * @brief Dispatcher to delete an object. + * @SINCE_1_0.0 + * @param[in] functorPtr A functor object to delete */ static void Delete( void* functorPtr ) { @@ -65,7 +70,8 @@ struct FunctorDestroyer }; /** - * @brief Used to connect a void() functor to a signal via BaseObject::SignalConnect() + * @brief Used to connect a void() functor to a signal via BaseObject::SignalConnect(). + * @SINCE_1_0.0 */ class DALI_IMPORT_API FunctorDelegate { @@ -74,6 +80,7 @@ public: /** * @brief Constructor which copies a function object. * + * @SINCE_1_0.0 * @param[in] functor The functor object to copy, either a class with operator() or a C function * @return A pointer to the new function object */ @@ -87,11 +94,13 @@ public: /** * @brief Non-virtual destructor; not intended as a base class. + * @SINCE_1_0.0 */ ~FunctorDelegate(); /** - * @brief Function to call the function or member function dispatcher + * @brief Function to call the function or member function dispatcher. + * @SINCE_1_0.0 */ void Execute(); @@ -99,30 +108,35 @@ private: /** * @brief Used to call the correct function. + * @SINCE_1_0.0 */ typedef void (*Dispatcher)( void* objectPtr ); /** * @brief Used to destroy mObjectPointer. + * @SINCE_1_0.0 */ typedef void(*Destructor)( void* objectPtr ); /** - * @brief Not defined + * @brief Not defined. + * @SINCE_1_0.0 */ FunctorDelegate( const FunctorDelegate& rhs ); /** - * @brief Not defined + * @brief Not defined. + * @SINCE_1_0.0 */ const FunctorDelegate& operator=( const FunctorDelegate& rhs ); /** * @brief Private constructor. * + * @SINCE_1_0.0 * @param[in] functorPtr A newly allocated functor object (takes ownership) - * @param dispatcher Used to call the actual function. - * @param destructor Used to delete the owned functor object. + * @param dispatcher Used to call the actual function + * @param destructor Used to delete the owned functor object */ FunctorDelegate( void* functorPtr, Dispatcher dispatcher, Destructor destructor );