X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fsignals%2Fsignal-slot-connections.h;h=e3b1e76238aa7b676e0f413068774b0d2bd40d14;hb=baad1726f5f7f05d98da7ca591f24dbe3c49dab2;hp=ec51d87d07240f01148880bf1907d4c3911e0b7a;hpb=54dff6a35a504884c076a370b660ed9a0a6c6bdb;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/signals/signal-slot-connections.h b/dali/public-api/signals/signal-slot-connections.h index ec51d87..e3b1e76 100644 --- a/dali/public-api/signals/signal-slot-connections.h +++ b/dali/public-api/signals/signal-slot-connections.h @@ -1,8 +1,8 @@ -#ifndef __DALI_SIGNAL_SLOT_CONNECTIONS_H__ -#define __DALI_SIGNAL_SLOT_CONNECTIONS_H__ +#ifndef DALI_SIGNAL_SLOT_CONNECTIONS_H +#define DALI_SIGNAL_SLOT_CONNECTIONS_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2019 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. @@ -24,7 +24,7 @@ namespace Dali { /** - * @addtogroup dali-core-signals + * @addtogroup dali_core_signals * @{ */ @@ -41,42 +41,47 @@ class CallbackBase; * - SlotObserver -interface provided by the signal * * It holds a pointer to the callback, but does not own it. + * @SINCE_1_0.0 */ -class DALI_IMPORT_API SlotConnection +class DALI_CORE_API SlotConnection { public: /** * @brief Constructor. * - * @param[in] slotObserver The slot observer. - * @param[in] callback A callback object (not owned). + * @SINCE_1_0.0 + * @param[in] slotObserver The slot observer + * @param[in] callback A callback object (not owned) */ SlotConnection(SlotObserver* slotObserver, CallbackBase* callback); /** * @brief Non-virtual destructor, not intended as a base class. + * @SINCE_1_0.0 */ ~SlotConnection(); /** - * @brief Retrieve the callback. + * @brief Retrieves the callback. * - * @return A pointer to the callback. + * @SINCE_1_0.0 + * @return A pointer to the callback */ CallbackBase* GetCallback(); /** - * @brief Retrieve the slot observer. + * @brief Retrieves the slot observer. * - * @return A pointer to the slot observer. + * @SINCE_1_0.0 + * @return A pointer to the slot observer */ SlotObserver* GetSlotObserver(); private: - SlotConnection( const SlotConnection& ); ///< undefined copy constructor - SlotConnection& operator=( const SlotConnection& ); ///< undefined assignment operator + SlotConnection( const SlotConnection& ); ///< undefined copy constructor @SINCE_1_0.0 + SlotConnection& operator=( const SlotConnection& ); ///< undefined assignment operator @SINCE_1_0.0 private: @@ -96,49 +101,55 @@ private: * * It takes ownership of the callback, and will delete it when * the connection is destroyed. + * @SINCE_1_0.0 */ -class DALI_IMPORT_API SignalConnection +class DALI_CORE_API SignalConnection { public: /** * @brief Constructor. * - * @param[in] callback The callback which should be a C function. + * @SINCE_1_0.0 + * @param[in] callback The callback which should be a C function */ SignalConnection( CallbackBase* callback ); /** * @brief Constructor. * - * @param[in] signalObserver The signal observer. - * @param[in] callback Ownership of this callback object is taken. + * @SINCE_1_0.0 + * @param[in] signalObserver The signal observer + * @param[in] callback Ownership of this callback object is taken */ SignalConnection( SignalObserver* signalObserver, CallbackBase* callback ); /** * @brief Non-virtual destructor, not intended as a base class. + * @SINCE_1_0.0 */ ~SignalConnection(); /** - * @brief Disconnect the signal from the slot. + * @brief Disconnects the signal from the slot. * - * @param[in] slotObserver The signal disconnecting from the slot. + * @SINCE_1_0.0 + * @param[in] slotObserver The signal disconnecting from the slot */ void Disconnect( SlotObserver* slotObserver ); /** - * @brief Retrieve the callback. + * @brief Retrieves the callback. * - * @return A pointer to the callback. + * @SINCE_1_0.0 + * @return A pointer to the callback */ CallbackBase* GetCallback(); private: - SignalConnection( const SignalConnection& ); ///< undefined copy constructor - SignalConnection& operator=( const SignalConnection& ); ///< undefined assignment operator + SignalConnection( const SignalConnection& ); ///< undefined copy constructor @SINCE_1_0.0 + SignalConnection& operator=( const SignalConnection& ); ///< undefined assignment operator @SINCE_1_0.0 private: @@ -151,4 +162,4 @@ private: */ } // namespace Dali -#endif // __DALI_SIGNAL_SLOT_CONNECTIONS_H__ +#endif // DALI_SIGNAL_SLOT_CONNECTIONS_H