X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fsignals%2Fcallback.h;h=5224ee81e76e2a8a9d4c89554c519b127364261c;hb=649ec06daecb510fb84fe4642a6af957f127e7ab;hp=5d869602ffa4b7ea4dc9ce4e042369cd3f0d5d28;hpb=d894f394cfdeea4e482b0666fe25d6039dca6bcb;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/signals/callback.h b/dali/public-api/signals/callback.h index 5d86960..5224ee8 100644 --- a/dali/public-api/signals/callback.h +++ b/dali/public-api/signals/callback.h @@ -2,7 +2,7 @@ #define __DALI_CALLBACK_H__ /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2018 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -38,18 +38,18 @@ class CallbackBase; * @brief Callback base class to hold the data for callback function and member function calls. * @SINCE_1_0.0 */ -class DALI_IMPORT_API CallbackBase +class DALI_CORE_API CallbackBase { public: /** - * @brief Default constructor + * @brief Default constructor. * @SINCE_1_0.0 */ CallbackBase(); /** - * @brief Destructor + * @brief Destructor. * @SINCE_1_0.0 */ ~CallbackBase(); @@ -61,10 +61,10 @@ public: void Reset(); /** - * @brief Function to call the function or member function dispatcher + * @brief Function to call the function or member function dispatcher. * * @SINCE_1_0.0 - * @param[in] callback The callback to call. + * @param[in] callback The callback to call */ static void Execute( CallbackBase& callback ) { @@ -93,8 +93,8 @@ public: * @brief Function to call the function or member function dispatcher. * * @SINCE_1_0.0 - * @param[in] callback The callback to call. - * @return value from the function + * @param[in] callback The callback to call + * @return The value from the function */ template< typename R > static R ExecuteReturn( CallbackBase& callback ) @@ -122,10 +122,10 @@ public: /** * @brief Function to call the function or member function dispatcher. * - * This function template gets instantiated at the call site + * This function template gets instantiated at the call site. * @SINCE_1_0.0 - * @param[in] callback The callback to call. - * @param[in] param1 The first parameter to pass into the function. + * @param[in] callback The callback to call + * @param[in] param1 The first parameter to pass into the function */ template< typename P1 > static void Execute( CallbackBase& callback, P1 param1 ) @@ -151,11 +151,11 @@ public: /** * @brief Function to call the function or member function dispatcher. * - * This function template gets instantiated at the call site + * This function template gets instantiated at the call site. * @SINCE_1_0.0 - * @param[in] callback The callback to call. - * @param[in] param1 The first parameter to pass into the function. - * @return the value from the function + * @param[in] callback The callback to call + * @param[in] param1 The first parameter to pass into the function + * @return The value from the function */ template< typename R, typename P1 > static R ExecuteReturn( CallbackBase& callback, P1 param1 ) @@ -186,9 +186,9 @@ public: * * This function template gets instantiated at the call site. * @SINCE_1_0.0 - * @param[in] callback The callback to call. - * @param[in] param1 The first parameter to pass into the function. - * @param[in] param2 The second parameter to pass into the function. + * @param[in] callback The callback to call + * @param[in] param1 The first parameter to pass into the function + * @param[in] param2 The second parameter to pass into the function */ template< typename P1, typename P2 > static void Execute( CallbackBase& callback, P1 param1, P2 param2 ) @@ -214,11 +214,11 @@ public: /** * @brief Function to call the function or member function dispatcher. * - * This function template gets instantiated at the call site + * This function template gets instantiated at the call site. * @SINCE_1_0.0 - * @param[in] callback The callback to call. - * @param[in] param1 The first parameter to pass into the function. - * @param[in] param2 The second parameter to pass into the function. + * @param[in] callback The callback to call + * @param[in] param1 The first parameter to pass into the function + * @param[in] param2 The second parameter to pass into the function * @return The return value from the function */ template< typename R, typename P1, typename P2 > @@ -250,10 +250,10 @@ public: * * This function template gets instantiated at the call site. * @SINCE_1_0.0 - * @param[in] callback The callback to call. - * @param[in] param1 The first parameter to pass into the function. - * @param[in] param2 The second parameter to pass into the function. - * @param[in] param3 The third parameter to pass into the function. + * @param[in] callback The callback to call + * @param[in] param1 The first parameter to pass into the function + * @param[in] param2 The second parameter to pass into the function + * @param[in] param3 The third parameter to pass into the function */ template< typename P1, typename P2, typename P3 > static void Execute( CallbackBase& callback, P1 param1, P2 param2, P3 param3 ) @@ -279,12 +279,12 @@ public: /** * @brief Function to call the function or member function dispatcher. * - * This function template gets instantiated at the call site + * This function template gets instantiated at the call site. * @SINCE_1_0.0 - * @param[in] callback The callback to call. - * @param[in] param1 The first parameter to pass into the function. - * @param[in] param2 The second parameter to pass into the function. - * @param[in] param3 The third parameter to pass into the function. + * @param[in] callback The callback to call + * @param[in] param1 The first parameter to pass into the function + * @param[in] param2 The second parameter to pass into the function + * @param[in] param3 The third parameter to pass into the function * @return The return value from the function */ template< typename R, typename P1, typename P2, typename P3 > @@ -314,25 +314,25 @@ public: protected: // Constructors for deriving classes /** - * @brief Function with static linkage + * @brief Function with static linkage. * @SINCE_1_0.0 */ typedef void(*Function)(void); /** - * @brief Member function + * @brief Member function. * @SINCE_1_0.0 */ typedef void (CallbackBase::*MemberFunction)( void ); /** - * @brief Used to call the correct member function + * @brief Used to call the correct member function. * @SINCE_1_0.0 */ typedef void (*Dispatcher)( CallbackBase& base ); /** - * @brief Used to destroy mObjectPointer (NULL if not mObjectPointer is not owned) + * @brief Used to destroy mObjectPointer (NULL if not mObjectPointer is not owned). * @SINCE_1_0.0 */ typedef void(*Destructor)(void* object); @@ -340,19 +340,23 @@ protected: // Constructors for deriving classes /** * @brief Copy constructor operator not declared. * @SINCE_1_0.0 + * @param[in] rhs Handle to an object */ CallbackBase( const CallbackBase& rhs ); + /** - * @brief assignment operator not declared. + * @brief Assignment operator not declared. * @SINCE_1_0.0 + * @param[in] rhs Handle to an object + * @return A reference to this */ - const CallbackBase& operator=( const CallbackBase& rhs ); + CallbackBase& operator=( const CallbackBase& rhs ); /** * @brief Constructor for function with static linkage. * * @SINCE_1_0.0 - * @param[in] function The function to call. + * @param[in] function The function to call */ CallbackBase( Function function ); @@ -360,9 +364,9 @@ protected: // Constructors for deriving classes * @brief Constructor for member function. * * @SINCE_1_0.0 - * @param[in] object The object to call (not owned). - * @param[in] function The member function of the object. - * @param[in] dispatcher Used to call the actual object. + * @param[in] object The object to call (not owned) + * @param[in] function The member function of the object + * @param[in] dispatcher Used to call the actual object */ CallbackBase( void* object, MemberFunction function, Dispatcher dispatcher ); @@ -370,17 +374,17 @@ protected: // Constructors for deriving classes * @brief Constructor for member function. * * @SINCE_1_0.0 - * @param[in] object The object to call (owned). - * @param[in] function The member function of the object. - * @param dispatcher Used to call the actual object. - * @param destructor Used to delete the owned object. + * @param[in] object The object to call (owned) + * @param[in] function The member function of the object + * @param dispatcher Used to call the actual object + * @param destructor Used to delete the owned object */ CallbackBase( void* object, MemberFunction function, Dispatcher dispatcher, Destructor destructor ); public: // Data for deriving classes & Dispatchers /** - * @brief struct to hold the extra data needed for member functions. + * @brief Struct to hold the extra data needed for member functions. * @SINCE_1_0.0 */ struct Impl @@ -401,8 +405,11 @@ public: // Data for deriving classes & Dispatchers }; /** - * @brief Non-member equality operator + * @brief Non-member equality operator. * @SINCE_1_0.0 + * @param[in] lhs A reference to compare + * @param[in] rhs A reference to compare to + * @return True if lhs is same as rhs */ bool operator==( const CallbackBase& lhs, const CallbackBase& rhs ); @@ -416,6 +423,7 @@ struct Destroyer /** * @brief Dispatcher to delete an object. * @SINCE_1_0.0 + * @param[in] object An object to delete */ static void Delete( void* object ) { @@ -433,10 +441,10 @@ template< class T > struct Dispatcher0 { /** - * @brief Call an actual member function. + * @brief Calls an actual member function. * * @SINCE_1_0.0 - * @param[in] callback The callback information. + * @param[in] callback The callback information */ static void Dispatch( CallbackBase& callback ) { @@ -456,11 +464,11 @@ template< class T, typename P1 > struct Dispatcher1 { /** - * @brief Call an actual member function. + * @brief Calls an actual member function. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function */ static void Dispatch( CallbackBase& callback, P1 param1 ) { @@ -483,9 +491,9 @@ struct Dispatcher2 * @brief Call an actual member function. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. - * @param[in] param2 The second parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function + * @param[in] param2 The second parameter to pass to the real member function */ static void Dispatch( CallbackBase& callback, P1 param1, P2 param2 ) { @@ -508,10 +516,10 @@ struct Dispatcher3 * @brief Call an actual member function. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. - * @param[in] param2 The second parameter to pass to the real member function. - * @param[in] param3 The third parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function + * @param[in] param2 The second parameter to pass to the real member function + * @param[in] param3 The third parameter to pass to the real member function */ static void Dispatch( CallbackBase& callback, P1 param1, P2 param2, P3 param3 ) { @@ -531,11 +539,11 @@ template< class T, typename R > struct DispatcherReturn0 { /** - * @brief Call an actual member function. + * @brief Calls an actual member function. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @return the value. + * @param[in] callback The callback information + * @return The value */ static R Dispatch( CallbackBase& callback ) { @@ -555,11 +563,11 @@ template< class T, typename R, typename P1 > struct DispatcherReturn1 { /** - * @brief Call an actual member function. + * @brief Calls an actual member function. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function * @return The return value from the function */ static R Dispatch( CallbackBase& callback, P1 param1 ) @@ -580,12 +588,12 @@ template< class T, typename R, typename P1, typename P2 > struct DispatcherReturn2 { /** - * @brief Call an actual member function. + * @brief Calls an actual member function. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. - * @param[in] param2 The second parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function + * @param[in] param2 The second parameter to pass to the real member function * @return The return value from the function */ static R Dispatch( CallbackBase& callback, P1 param1, P2 param2 ) @@ -606,13 +614,13 @@ template< class T, typename R, typename P1, typename P2, typename P3 > struct DispatcherReturn3 { /** - * @brief Call an actual member function. + * @brief Calls an actual member function. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. - * @param[in] param2 The second parameter to pass to the real member function. - * @param[in] param3 The third parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function + * @param[in] param2 The second parameter to pass to the real member function + * @param[in] param3 The third parameter to pass to the real member function * @return The return value from the function */ static R Dispatch( CallbackBase& callback, P1 param1, P2 param2, P3 param3 ) @@ -633,10 +641,10 @@ template< class T > struct FunctorDispatcher0 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. + * @param[in] callback The callback information */ static void Dispatch( CallbackBase& callback ) { @@ -654,10 +662,10 @@ template< class T, typename P1 > struct FunctorDispatcher1 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. + * @param[in] callback The callback information * @param[in] param1 The first parameter to pass to the real member function. */ static void Dispatch( CallbackBase& callback, P1 param1 ) @@ -676,12 +684,12 @@ template< class T, typename P1, typename P2 > struct FunctorDispatcher2 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. - * @param[in] param2 The second parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function + * @param[in] param2 The second parameter to pass to the real member function */ static void Dispatch( CallbackBase& callback, P1 param1, P2 param2 ) { @@ -699,13 +707,13 @@ template< class T, typename P1, typename P2, typename P3 > struct FunctorDispatcher3 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. - * @param[in] param2 The second parameter to pass to the real member function. - * @param[in] param3 The third parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function + * @param[in] param2 The second parameter to pass to the real member function + * @param[in] param3 The third parameter to pass to the real member function */ static void Dispatch( CallbackBase& callback, P1 param1, P2 param2, P3 param3 ) { @@ -723,11 +731,11 @@ template< class T, typename R > struct FunctorDispatcherReturn0 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @return the value. + * @param[in] callback The callback information + * @return The value */ static R Dispatch( CallbackBase& callback ) { @@ -745,11 +753,11 @@ template< class T, typename R, typename P1 > struct FunctorDispatcherReturn1 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function * @return The return value from the function */ static R Dispatch( CallbackBase& callback, P1 param1 ) @@ -768,12 +776,12 @@ template< class T, typename R, typename P1, typename P2 > struct FunctorDispatcherReturn2 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. - * @param[in] param2 The second parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function + * @param[in] param2 The second parameter to pass to the real member function * @return The return value from the function */ static R Dispatch( CallbackBase& callback, P1 param1, P2 param2 ) @@ -792,13 +800,13 @@ template< class T, typename R, typename P1, typename P2, typename P3 > struct FunctorDispatcherReturn3 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. - * @param[in] param2 The second parameter to pass to the real member function. - * @param[in] param3 The third parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function + * @param[in] param2 The second parameter to pass to the real member function + * @param[in] param3 The third parameter to pass to the real member function * @return The return value from the function */ static R Dispatch( CallbackBase& callback, P1 param1, P2 param2, P3 param3 ) @@ -811,6 +819,7 @@ struct FunctorDispatcherReturn3 /** * @brief Dispatcher to call a functor. + * * This variant calls a specific void() member function. * @SINCE_1_0.0 */ @@ -818,10 +827,10 @@ template< class T > struct VoidFunctorDispatcher0 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. + * @param[in] callback The callback information */ static void Dispatch( CallbackBase& callback ) { @@ -836,18 +845,18 @@ struct VoidFunctorDispatcher0 /** * @brief Dispatcher to call a functor. * - * This variant calls a void() member, ignoring any signal parameters + * This variant calls a void() member, ignoring any signal parameters. * @SINCE_1_0.0 */ template< class T, typename P1 > struct VoidFunctorDispatcher1 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function */ static void Dispatch( CallbackBase& callback, P1 param1 ) { @@ -862,19 +871,19 @@ struct VoidFunctorDispatcher1 /** * @brief Dispatcher to call a functor. * - * This variant calls a void() member, ignoring any signal parameters + * This variant calls a void() member, ignoring any signal parameters. * @SINCE_1_0.0 */ template< class T, typename P1, typename P2 > struct VoidFunctorDispatcher2 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. - * @param[in] param2 The second parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function + * @param[in] param2 The second parameter to pass to the real member function */ static void Dispatch( CallbackBase& callback, P1 param1, P2 param2 ) { @@ -889,20 +898,20 @@ struct VoidFunctorDispatcher2 /** * @brief Dispatcher to call a functor. * - * This variant calls a void() member, ignoring any signal parameters + * This variant calls a void() member, ignoring any signal parameters. * @SINCE_1_0.0 */ template< class T, typename P1, typename P2, typename P3 > struct VoidFunctorDispatcher3 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. - * @param[in] param2 The second parameter to pass to the real member function. - * @param[in] param3 The third parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function + * @param[in] param2 The second parameter to pass to the real member function + * @param[in] param3 The third parameter to pass to the real member function */ static void Dispatch( CallbackBase& callback, P1 param1, P2 param2, P3 param3 ) { @@ -917,18 +926,18 @@ struct VoidFunctorDispatcher3 /** * @brief Dispatcher to call a functor. * - * This variant calls a void() member, and returns a default-constructed value + * This variant calls a void() member, and returns a default-constructed value. * @SINCE_1_0.0 */ template< class T, typename R > struct VoidFunctorDispatcherReturn0 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @return the value. + * @param[in] callback The callback information + * @return The value */ static R Dispatch( CallbackBase& callback ) { @@ -944,18 +953,18 @@ struct VoidFunctorDispatcherReturn0 /** * @brief Dispatcher to call a functor. * - * This variant calls a void() member, and returns a default-constructed value + * This variant calls a void() member, and returns a default-constructed value. * @SINCE_1_0.0 */ template< class T, typename R, typename P1 > struct VoidFunctorDispatcherReturn1 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function * @return The return value from the function */ static R Dispatch( CallbackBase& callback, P1 param1 ) @@ -972,19 +981,19 @@ struct VoidFunctorDispatcherReturn1 /** * @brief Dispatcher to call a functor. * - * This variant calls a void() member, and returns a default-constructed value + * This variant calls a void() member, and returns a default-constructed value. * @SINCE_1_0.0 */ template< class T, typename R, typename P1, typename P2 > struct VoidFunctorDispatcherReturn2 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. - * @param[in] param2 The second parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function + * @param[in] param2 The second parameter to pass to the real member function * @return The return value from the function */ static R Dispatch( CallbackBase& callback, P1 param1, P2 param2 ) @@ -1001,20 +1010,20 @@ struct VoidFunctorDispatcherReturn2 /** * @brief Dispatcher to call a functor. * - * This variant calls a void() member, and returns a default-constructed value + * This variant calls a void() member, and returns a default-constructed value. * @SINCE_1_0.0 */ template< class T, typename R, typename P1, typename P2, typename P3 > struct VoidFunctorDispatcherReturn3 { /** - * @brief Call a function object. + * @brief Calls a function object. * * @SINCE_1_0.0 - * @param[in] callback The callback information. - * @param[in] param1 The first parameter to pass to the real member function. - * @param[in] param2 The second parameter to pass to the real member function. - * @param[in] param3 The third parameter to pass to the real member function. + * @param[in] callback The callback information + * @param[in] param1 The first parameter to pass to the real member function + * @param[in] param2 The second parameter to pass to the real member function + * @param[in] param3 The third parameter to pass to the real member function * @return The return value from the function */ static R Dispatch( CallbackBase& callback, P1 param1, P2 param2, P3 param3 ) @@ -1031,7 +1040,7 @@ struct VoidFunctorDispatcherReturn3 /** * @brief Thin template to provide type safety for member function callbacks. * - * version with two parameters and return value + * Version with two parameters and return value. * @SINCE_1_0.0 */ template< class T > @@ -1054,8 +1063,8 @@ public: * * Copies the function object. * @SINCE_1_0.0 - * @param[in] object The object to call. - * @param[in] memberFunction The member function of the object. + * @param[in] object The object to call + * @param[in] memberFunction The member function of the object */ Callback( T* object, void(T::*memberFunction)(void) ) : CallbackBase( object, @@ -1120,7 +1129,7 @@ public: * @brief Constructors for functions with static linkage. * * @SINCE_1_0.0 - * @param[in] function The function to call. + * @param[in] function The function to call */ CallbackFunction( void(*function)() ) : CallbackBase( reinterpret_cast< CallbackBase::Function >( function ) ) @@ -1169,7 +1178,7 @@ public: * @brief Constructor which copies a function object. * * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctor0( const T& object ) : CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object @@ -1179,7 +1188,7 @@ public: }; /** - * @brief Function object callback for connecting void() methods + * @brief Function object callback for connecting void() methods. * @SINCE_1_0.0 */ class CallbackFunctorDelegate0 : public CallbackBase @@ -1191,7 +1200,7 @@ public: * * This variant calls a void() member, ignoring any signal parameters. * @SINCE_1_0.0 - * @param[in] object A newly allocated object (ownership is transferred). + * @param[in] object A newly allocated object (ownership is transferred) */ CallbackFunctorDelegate0( FunctorDelegate* object ) : CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership @@ -1213,7 +1222,7 @@ public: * @brief Constructor which copies a function object. * * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctor1( const T& object ) : CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object @@ -1236,7 +1245,7 @@ public: * * This variant calls a void() member, ignoring any signal parameters. * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctorDelegate1( FunctorDelegate* object ) : CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership @@ -1246,7 +1255,7 @@ public: }; /** - * @brief Function object callback for matching callbacks to signal signature + * @brief Function object callback for matching callbacks to signal signature. * @SINCE_1_0.0 */ template< class T, typename P1, typename P2 > @@ -1258,7 +1267,7 @@ public: * @brief Constructor which copies a function object. * * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctor2( const T& object ) : CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object @@ -1268,7 +1277,7 @@ public: }; /** - * @brief Function object callback for connecting void() methods + * @brief Function object callback for connecting void() methods. * @SINCE_1_0.0 */ template< typename P1, typename P2 > @@ -1281,7 +1290,7 @@ public: * * This variant calls a void() member, ignoring any signal parameters. * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctorDelegate2( FunctorDelegate* object ) : CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership @@ -1291,7 +1300,7 @@ public: }; /** - * @brief Function object callback for matching callbacks to signal signature + * @brief Function object callback for matching callbacks to signal signature. * @SINCE_1_0.0 */ template< class T, typename P1, typename P2, typename P3 > @@ -1303,7 +1312,7 @@ public: * @brief Constructor which copies a function object. * * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctor3( const T& object ) : CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object @@ -1313,7 +1322,7 @@ public: }; /** - * @brief Function object callback for connecting void() methods + * @brief Function object callback for connecting void() methods. * @SINCE_1_0.0 */ template< typename P1, typename P2, typename P3 > @@ -1327,7 +1336,7 @@ public: * * This variant calls a void() member, ignoring any signal parameters. * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctorDelegate3( FunctorDelegate* object ) : CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership @@ -1337,7 +1346,7 @@ public: }; /** - * @brief Function object callback for matching callbacks to signal signature + * @brief Function object callback for matching callbacks to signal signature. * @SINCE_1_0.0 */ template< class T, typename R > @@ -1349,7 +1358,7 @@ public: * @brief Constructor which copies a function object. * * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctorReturn0( const T& object ) : CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object @@ -1359,7 +1368,7 @@ public: }; /** - * @brief Function object callback for connecting void() methods + * @brief Function object callback for connecting void() methods. * @SINCE_1_0.0 */ template< typename R > @@ -1372,7 +1381,7 @@ public: * * This variant calls a void() member, ignoring any signal parameters. * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctorDelegateReturn0( FunctorDelegate* object ) : CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership @@ -1382,7 +1391,7 @@ public: }; /** - * @brief Function object callback for matching callbacks to signal signature + * @brief Function object callback for matching callbacks to signal signature. * @SINCE_1_0.0 */ template< class T, typename P1, typename R > @@ -1394,7 +1403,7 @@ public: * @brief Constructor which copies a function object. * * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctorReturn1( const T& object ) : CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object @@ -1404,7 +1413,7 @@ public: }; /** - * @brief Function object callback for connecting void() methods + * @brief Function object callback for connecting void() methods. * @SINCE_1_0.0 */ template< typename P1, typename R > @@ -1417,7 +1426,7 @@ public: * * This variant calls a void() member, ignoring any signal parameters. * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctorDelegateReturn1( FunctorDelegate* object ) : CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership @@ -1427,7 +1436,7 @@ public: }; /** - * @brief Function object callback for matching callbacks to signal signature + * @brief Function object callback for matching callbacks to signal signature. * @SINCE_1_0.0 */ template< class T, typename P1, typename P2, typename R > @@ -1439,7 +1448,7 @@ public: * @brief Constructor which copies a function object. * * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctorReturn2( const T& object ) : CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object @@ -1449,7 +1458,7 @@ public: }; /** - * @brief Function object callback for connecting void() methods + * @brief Function object callback for connecting void() methods. * @SINCE_1_0.0 */ template< typename P1, typename P2, typename R > @@ -1462,7 +1471,7 @@ public: * * This variant calls a void() member, ignoring any signal parameters. * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctorDelegateReturn2( FunctorDelegate* object ) : CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership @@ -1472,7 +1481,7 @@ public: }; /** - * @brief Function object callback for matching callbacks to signal signature + * @brief Function object callback for matching callbacks to signal signature. * @SINCE_1_0.0 */ template< class T, typename P1, typename P2, typename P3, typename R > @@ -1484,7 +1493,7 @@ public: * @brief Constructor which copies a function object. * * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctorReturn3( const T& object ) : CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object @@ -1494,7 +1503,7 @@ public: }; /** - * @brief Function object callback for connecting void() methods + * @brief Function object callback for connecting void() methods. * @SINCE_1_0.0 */ template< typename P1, typename P2, typename P3, typename R > @@ -1507,7 +1516,7 @@ public: * * This variant calls a void() member, ignoring any signal parameters. * @SINCE_1_0.0 - * @param[in] object The object to copy. + * @param[in] object The object to copy */ CallbackFunctorDelegateReturn3( FunctorDelegate* object ) : CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership @@ -1522,8 +1531,8 @@ public: * @brief Creates a callback from a C function or static member function with no parameters. * * @SINCE_1_0.0 - * @param[in] function The function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] function The function to call + * @return A newly allocated Callback object, ownership transferred to caller */ inline CallbackBase* MakeCallback( void(*function)(void) ) { @@ -1534,8 +1543,8 @@ inline CallbackBase* MakeCallback( void(*function)(void) ) * @brief Creates a callback from a C function or static member function with one parameter. * * @SINCE_1_0.0 - * @param[in] function The function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] function The function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< typename P1 > inline CallbackBase* MakeCallback( void(*function)(P1) ) @@ -1547,8 +1556,8 @@ inline CallbackBase* MakeCallback( void(*function)(P1) ) * @brief Creates a callback from a C function or static member function with no parameters and a return type. * * @SINCE_1_0.0 - * @param[in] function The function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] function The function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< typename R > inline CallbackBase* MakeCallback( R(*function)(void) ) @@ -1560,8 +1569,8 @@ inline CallbackBase* MakeCallback( R(*function)(void) ) * @brief Creates a callback from a C function or static member function with one parameter and a return type. * * @SINCE_1_0.0 - * @param[in] function The function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] function The function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< typename R, typename P1 > inline CallbackBase* MakeCallback( R(*function)(P1) ) @@ -1573,8 +1582,8 @@ inline CallbackBase* MakeCallback( R(*function)(P1) ) * @brief Creates a callback from a C function or static member function with two parameters. * * @SINCE_1_0.0 - * @param[in] function The function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] function The function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< typename P1, typename P2 > inline CallbackBase* MakeCallback( void(*function)(P1,P2) ) @@ -1586,8 +1595,8 @@ inline CallbackBase* MakeCallback( void(*function)(P1,P2) ) * @brief Creates a callback from a C function or static member function with two parameters and a return type. * * @SINCE_1_0.0 - * @param[in] function The function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] function The function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< typename R, typename P1, typename P2 > inline CallbackBase* MakeCallback( R(*function)(P1,P2) ) @@ -1599,8 +1608,8 @@ inline CallbackBase* MakeCallback( R(*function)(P1,P2) ) * @brief Creates a callback from a C function or static member function with three parameters. * * @SINCE_1_0.0 - * @param[in] function The function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] function The function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< typename P1, typename P2, typename P3 > inline CallbackBase* MakeCallback( void(*function)(P1,P2,P3) ) @@ -1612,8 +1621,8 @@ inline CallbackBase* MakeCallback( void(*function)(P1,P2,P3) ) * @brief Creates a callback from a C function or static member function with three parameters and a return type. * * @SINCE_1_0.0 - * @param[in] function The function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] function The function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< typename R, typename P1, typename P2, typename P3 > inline CallbackBase* MakeCallback( R(*function)(P1,P2,P3) ) @@ -1624,11 +1633,11 @@ inline CallbackBase* MakeCallback( R(*function)(P1,P2,P3) ) /** * @brief Creates a callback from a class member function with no parameters. * - * requires the function to be member of the same class + * Requires the function to be member of the same class. * @SINCE_1_0.0 - * @param[in] object The object to call. - * @param[in] function The member function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] object The object to call + * @param[in] function The member function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< class T > inline CallbackBase* MakeCallback( T* object, void(T::*function)(void) ) @@ -1639,11 +1648,11 @@ inline CallbackBase* MakeCallback( T* object, void(T::*function)(void) ) /** * @brief Creates a callback from a class member function with one parameter. * - * requires the function to be member of the same class + * Requires the function to be member of the same class. * @SINCE_1_0.0 - * @param[in] object The object to call. - * @param[in] function The member function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] object The object to call + * @param[in] function The member function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< class T, typename P1 > inline CallbackBase* MakeCallback( T* object, void(T::*function)(P1) ) @@ -1654,11 +1663,11 @@ inline CallbackBase* MakeCallback( T* object, void(T::*function)(P1) ) /** * @brief Creates a callback from a class member function with two parameters. * - * requires the function to be member of the same class + * Requires the function to be member of the same class. * @SINCE_1_0.0 - * @param[in] object The object to call. - * @param[in] function The member function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] object The object to call + * @param[in] function The member function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< class T, typename P1, typename P2 > inline CallbackBase* MakeCallback( T* object, void(T::*function)(P1,P2) ) @@ -1669,11 +1678,11 @@ inline CallbackBase* MakeCallback( T* object, void(T::*function)(P1,P2) ) /** * @brief Creates a callback from a class member function with three parameters. * - * requires the function to be member of the same class + * Requires the function to be member of the same class. * @SINCE_1_0.0 - * @param[in] object The object to call. - * @param[in] function The member function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] object The object to call + * @param[in] function The member function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< class T, typename P1, typename P2, typename P3 > inline CallbackBase* MakeCallback( T* object, void(T::*function)(P1,P2,P3) ) @@ -1684,11 +1693,11 @@ inline CallbackBase* MakeCallback( T* object, void(T::*function)(P1,P2,P3) ) /** * @brief Creates a callback from a class member function with no parameters and a return type. * - * requires the function to be member of the same class + * Requires the function to be member of the same class. * @SINCE_1_0.0 - * @param[in] object The object to call. - * @param[in] function The member function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] object The object to call + * @param[in] function The member function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< class T, typename R > inline CallbackBase* MakeCallback( T* object, R(T::*function)() ) @@ -1699,11 +1708,11 @@ inline CallbackBase* MakeCallback( T* object, R(T::*function)() ) /** * @brief Creates a callback from a class member function with one parameter and a return type. * - * requires the function to be member of the same class + * Requires the function to be member of the same class. * @SINCE_1_0.0 - * @param[in] object The object to call. - * @param[in] function The member function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] object The object to call + * @param[in] function The member function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< class T, typename P1, typename R > inline CallbackBase* MakeCallback( T* object, R(T::*function)(P1) ) @@ -1714,11 +1723,11 @@ inline CallbackBase* MakeCallback( T* object, R(T::*function)(P1) ) /** * @brief Creates a callback from a class member function with two parameters and a return type. * - * requires the function to be member of the same class + * Requires the function to be member of the same class. * @SINCE_1_0.0 - * @param[in] object The object to call. - * @param[in] function The member function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] object The object to call + * @param[in] function The member function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< class T, typename P1, typename P2, typename R > inline CallbackBase* MakeCallback( T* object, R(T::*function)(P1,P2) ) @@ -1729,11 +1738,11 @@ inline CallbackBase* MakeCallback( T* object, R(T::*function)(P1,P2) ) /** * @brief Creates a callback from a class member function with three parameters and a return type. * - * requires the function to be member of the same class + * Requires the function to be member of the same class. * @SINCE_1_0.0 - * @param[in] object The object to call. - * @param[in] function The member function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] object The object to call + * @param[in] function The member function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< class T, typename P1, typename P2, typename P3, typename R > inline CallbackBase* MakeCallback( T* object, R(T::*function)(P1,P2,P3) ) @@ -1744,11 +1753,11 @@ inline CallbackBase* MakeCallback( T* object, R(T::*function)(P1,P2,P3) ) /** * @brief Creates a callback from a class's parent member function with no parameters. * - * requires the function to be member of the same class + * Requires the function to be member of the same class. * @SINCE_1_0.0 - * @param[in] object The object to call. - * @param[in] function The member function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] object The object to call + * @param[in] function The member function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< class T, class Base > inline CallbackBase* MakeCallback( T* object, void(Base::*function)(void) ) @@ -1758,11 +1767,11 @@ inline CallbackBase* MakeCallback( T* object, void(Base::*function)(void) ) /** * @brief Creates a callback from a class's parent member function with no parameters. * - * requires the function to be member of the same class + * Requires the function to be member of the same class. * @SINCE_1_0.0 - * @param[in] object The object to call. - * @param[in] function The member function to call. - * @return a newly allocated Callback object, ownership transferred to caller + * @param[in] object The object to call + * @param[in] function The member function to call + * @return A newly allocated Callback object, ownership transferred to caller */ template< class T, class Base > inline CallbackBase* MakeCallback( T& object, void(Base::*function)(void) )