#define __DALI_SIGNAL_SLOT_CONNECTIONS_H__
/*
- * Copyright (c) 2014 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.
// INTERNAL INCLUDES
#include <dali/public-api/signals/signal-slot-observers.h>
-namespace Dali DALI_IMPORT_API
+namespace Dali
{
+/**
+ * @addtogroup dali_core_signals
+ * @{
+ */
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 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:
*
* It takes ownership of the callback, and will delete it when
* the connection is destroyed.
+ * @SINCE_1_0.0
*/
-class 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:
CallbackBase* mCallback; ///< The callback, has ownership.
};
+/**
+ * @}
+ */
} // namespace Dali
#endif // __DALI_SIGNAL_SLOT_CONNECTIONS_H__