1 #ifndef __DALI_SIGNAL_SLOT_CONNECTIONS_H__
2 #define __DALI_SIGNAL_SLOT_CONNECTIONS_H__
5 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/signals/signal-slot-observers.h>
27 * @addtogroup dali_core_signals
34 * @brief Slot connection is the connection information held by a connection tracker.
36 * A slot can have zero to many connection objects, depending
37 * on how many signals it is connected to.
39 * A connection contains:
41 * - SlotObserver -interface provided by the signal
43 * It holds a pointer to the callback, but does not own it.
46 class DALI_CORE_API SlotConnection
54 * @param[in] slotObserver The slot observer
55 * @param[in] callback A callback object (not owned)
57 SlotConnection(SlotObserver* slotObserver, CallbackBase* callback);
60 * @brief Non-virtual destructor, not intended as a base class.
66 * @brief Retrieves the callback.
69 * @return A pointer to the callback
71 CallbackBase* GetCallback();
74 * @brief Retrieves the slot observer.
77 * @return A pointer to the slot observer
79 SlotObserver* GetSlotObserver();
83 SlotConnection( const SlotConnection& ); ///< undefined copy constructor @SINCE_1_0.0
84 SlotConnection& operator=( const SlotConnection& ); ///< undefined assignment operator @SINCE_1_0.0
88 SlotObserver* mSlotObserver; ///< a pointer to the slot observer (not owned)
89 CallbackBase* mCallback; ///< The callback. This is not owned, the corresponding SignalConnection has ownership.
93 * @brief SignalConnection is the connection information held by the signal.
95 * A signal can have zero to many connections, depending on how
96 * many slots are connected to this signal.
98 * A connection contains:
100 * - SignalObserver - interface provided by a slot owning object.
102 * It takes ownership of the callback, and will delete it when
103 * the connection is destroyed.
106 class DALI_CORE_API SignalConnection
111 * @brief Constructor.
114 * @param[in] callback The callback which should be a C function
116 SignalConnection( CallbackBase* callback );
119 * @brief Constructor.
122 * @param[in] signalObserver The signal observer
123 * @param[in] callback Ownership of this callback object is taken
125 SignalConnection( SignalObserver* signalObserver, CallbackBase* callback );
128 * @brief Non-virtual destructor, not intended as a base class.
134 * @brief Disconnects the signal from the slot.
137 * @param[in] slotObserver The signal disconnecting from the slot
139 void Disconnect( SlotObserver* slotObserver );
142 * @brief Retrieves the callback.
145 * @return A pointer to the callback
147 CallbackBase* GetCallback();
151 SignalConnection( const SignalConnection& ); ///< undefined copy constructor @SINCE_1_0.0
152 SignalConnection& operator=( const SignalConnection& ); ///< undefined assignment operator @SINCE_1_0.0
156 SignalObserver* mSignalObserver; ///< a pointer to the signal observer (not owned)
157 CallbackBase* mCallback; ///< The callback, has ownership.
165 #endif // __DALI_SIGNAL_SLOT_CONNECTIONS_H__