X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fsignals%2Fbase-signal.h;h=159cc6ed7accd59685b210548228df4b9c38e7e7;hb=4d75040ab200bd306ec5a48f2a617480062eef4c;hp=02e15a56b9500b2fb906e482ba9c20c97cbfdf58;hpb=ee10696686152727bb14e568f7259420e01c8214;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/signals/base-signal.h b/dali/public-api/signals/base-signal.h old mode 100644 new mode 100755 index 02e15a5..159cc6e --- a/dali/public-api/signals/base-signal.h +++ b/dali/public-api/signals/base-signal.h @@ -2,7 +2,7 @@ #define __DALI_BASE_SIGNAL_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. @@ -69,13 +69,13 @@ namespace Dali * %Callback 2 Slot Observer 2 * * - * When the connection tracker is destroyed, SlotDisconnected() is called on every slot observer ( signal ) - * Signals implement the Slot Observer interface, to be told when a slot has disconnected - * Connection tracker implements the Signal Observer interface, to be told when a signal has disconnected (died) + * When the connection tracker is destroyed, SlotDisconnected() is called on every slot observer ( signal ). + * Signals implement the Slot Observer interface, to be told when a slot has disconnected. + * Connection tracker implements the Signal Observer interface, to be told when a signal has disconnected (died). * * @SINCE_1_0.0 */ -class DALI_IMPORT_API BaseSignal : public SlotObserver +class DALI_CORE_API BaseSignal : public SlotObserver { public: @@ -92,7 +92,7 @@ public: virtual ~BaseSignal(); /** - * @brief Query whether there are any connected slots. + * @brief Queries whether there are any connected slots. * * @SINCE_1_0.0 * @return True if there are any slots connected to the signal. @@ -100,10 +100,10 @@ public: bool Empty() const; /** - * @brief Query the number of slots. + * @brief Queries the number of slots. * * @SINCE_1_0.0 - * @return The number of slots connected to this signal. + * @return The number of slots connected to this signal */ std::size_t GetConnectionCount() const; @@ -113,13 +113,13 @@ public: * @brief Used to guard against nested Emit() calls. * @SINCE_1_0.0 */ - struct EmitGuard + struct DALI_CORE_API EmitGuard { /** - * @brief Create the guard. + * @brief Creates the guard. * * @SINCE_1_0.0 - * @param[in,out] flag This flag will be set to true during Emit() calls. + * @param[in,out] flag This flag will be set to true during Emit() calls */ EmitGuard( bool& flag ); @@ -131,7 +131,7 @@ public: ~EmitGuard(); /** - * @brief Determine if an error occured. + * @brief Determines if an error occurred. * * @SINCE_1_0.0 * @return True if an error occurred i.e. if Emit() was called during Emit() @@ -142,7 +142,7 @@ public: }; /** - * @brief Emit a signal with no parameters. + * @brief Emits a signal with no parameters. * * @SINCE_1_0.0 * @pre Cannot be called from inside the same Signal's Emit methods. @@ -150,10 +150,10 @@ public: void Emit(); /** - * @brief Emit a signal with no parameters. + * @brief Emits a signal with no parameters. * * @SINCE_1_0.0 - * @return The value returned by the last callback. + * @return The value returned by the last callback * @pre Cannot be called from inside the same Signal's Emit methods. */ template< typename Ret > @@ -191,10 +191,10 @@ public: } /** - * @brief Emit a signal with 1 parameter. + * @brief Emits a signal with 1 parameter. * * @SINCE_1_0.0 - * @param[in] arg0 The first parameter. + * @param[in] arg0 The first parameter * @pre Cannot be called from inside the same Signal's Emit methods. */ template< typename Arg0 > @@ -228,11 +228,11 @@ public: } /** - * @brief Emit a signal with 1 parameter. + * @brief Emits a signal with 1 parameter. * * @SINCE_1_0.0 - * @param[in] arg0 The first parameter. - * @return The value returned by the last callback. + * @param[in] arg0 The first parameter + * @return The value returned by the last callback * @pre Cannot be called from inside the same Signal's Emit methods. */ template< typename Ret, typename Arg0 > @@ -270,11 +270,11 @@ public: } /** - * @brief Emit a signal with 2 parameters. + * @brief Emits a signal with 2 parameters. * * @SINCE_1_0.0 - * @param[in] arg0 The first parameter. - * @param[in] arg1 The second parameter. + * @param[in] arg0 The first parameter + * @param[in] arg1 The second parameter * @pre Cannot be called from inside the same Signal's Emit methods. */ template< typename Arg0, typename Arg1 > @@ -308,12 +308,12 @@ public: } /** - * @brief Emit a signal with 2 parameters. + * @brief Emits a signal with 2 parameters. * * @SINCE_1_0.0 - * @param[in] arg0 The first parameter. - * @param[in] arg1 The second parameter. - * @return The value returned by the last callback. + * @param[in] arg0 The first parameter + * @param[in] arg1 The second parameter + * @return The value returned by the last callback * @pre Cannot be called from inside the same Signal's Emit methods. */ template< typename Ret, typename Arg0, typename Arg1 > @@ -351,12 +351,12 @@ public: } /** - * @brief Emit a signal with 3 parameters. + * @brief Emits a signal with 3 parameters. * * @SINCE_1_0.0 - * @param[in] arg0 The first parameter. - * @param[in] arg1 The second parameter. - * @param[in] arg2 The third parameter. + * @param[in] arg0 The first parameter + * @param[in] arg1 The second parameter + * @param[in] arg2 The third parameter * @pre Cannot be called from inside the same Signal's Emit methods. */ template< typename Arg0, typename Arg1, typename Arg2 > @@ -390,13 +390,13 @@ public: } /** - * @brief Emit a signal with 3 parameters. + * @brief Emits a signal with 3 parameters. * * @SINCE_1_0.0 - * @param[in] arg0 The first parameter. - * @param[in] arg1 The second parameter. - * @param[in] arg2 The third parameter. - * @return The value returned by the last callback. + * @param[in] arg0 The first parameter + * @param[in] arg1 The second parameter + * @param[in] arg2 The third parameter + * @return The value returned by the last callback * @pre Cannot be called from inside the same Signal's Emit methods. */ template< typename Ret, typename Arg0, typename Arg1, typename Arg2 > @@ -436,36 +436,36 @@ public: // Connect / Disconnect function for use by Signal implementations /** - * @brief Called by Signal implementations, when the user calls Signal.Connect( ... ) + * @brief Called by Signal implementations, when the user calls Signal.Connect( ... ). * * @SINCE_1_0.0 - * @param[in] callback A newly allocated callback object (takes ownership). + * @param[in] callback A newly allocated callback object (takes ownership) */ void OnConnect( CallbackBase* callback ); /** - * @brief Called by Signal implementations, when the user calls Signal.Disconnect( ... ) + * @brief Called by Signal implementations, when the user calls Signal.Disconnect( ... ). * * @SINCE_1_0.0 - * @param[in] callback A newly allocated callback object (takes ownership). + * @param[in] callback A newly allocated callback object (takes ownership) */ void OnDisconnect( CallbackBase* callback ); /** - * @brief Called by Signal implementations, when the user calls Signal.Connect( ... ) + * @brief Called by Signal implementations, when the user calls Signal.Connect( ... ). * * @SINCE_1_0.0 - * @param[in] tracker The connection tracker. - * @param[in] callback A newly allocated callback object (takes ownership). + * @param[in] tracker The connection tracker + * @param[in] callback A newly allocated callback object (takes ownership) */ void OnConnect( ConnectionTrackerInterface* tracker, CallbackBase* callback ); /** - * @brief Called by Signal implementations, when the user calls Signal.Disconnect( ... ) + * @brief Called by Signal implementations, when the user calls Signal.Disconnect( ... ). * * @SINCE_1_0.0 - * @param[in] tracker The connection tracker. - * @param[in] callback A newly allocated callback object (takes ownership). + * @param[in] tracker The connection tracker + * @param[in] callback A newly allocated callback object (takes ownership) */ void OnDisconnect( ConnectionTrackerInterface* tracker, CallbackBase* callback ); @@ -482,8 +482,8 @@ private: * @brief Returns a callback given an index in to the connection array. * * @SINCE_1_0.0 - * @param[in] connectionIndex The index of the callback. - * @return The callback, or NULL if the connection has been deleted. + * @param[in] connectionIndex The index of the callback + * @return The callback, or NULL if the connection has been deleted */ CallbackBase* GetCallback( std::size_t connectionIndex ) const; @@ -491,8 +491,8 @@ private: * @brief Helper to find whether a callback is connected. * * @SINCE_1_0.0 - * @param[in] callback The call back object. - * @return A valid index if the callback is connected. + * @param[in] callback The call back object + * @return A valid index if the callback is connected */ int FindCallback( CallbackBase* callback ); @@ -500,7 +500,7 @@ private: * @brief Deletes a connection object from the list of connections. * * @SINCE_1_0.0 - * @param[in] connectionIndex The index of the callback. + * @param[in] connectionIndex The index of the callback */ void DeleteConnection( std::size_t connectionIndex );