1 #ifndef __DALI_SIGNAL_SLOT_CONNECTIONS_H__
2 #define __DALI_SIGNAL_SLOT_CONNECTIONS_H__
5 * Copyright (c) 2014 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>
24 namespace Dali DALI_IMPORT_API
30 * @brief Slot connection is the connection information held by a connection tracker.
32 * A slot can have zero to many connection objects, depending
33 * on how many signals it is connected to.
35 * A connection contains:
37 * - SlotObserver -interface provided by the signal
39 * It takes ownership of the callback, and will delete it when
40 * the connection is destroyed.
49 * @param[in] slotObserver The slot observer.
50 * @param[in] callback Ownership of this callback object is taken.
52 SlotConnection(SlotObserver* slotObserver, CallbackBase* callback);
55 * @brief Non-virtual destructor, not intended as a base class.
60 * @brief Retrieve the callback.
62 * @return A pointer to the callback.
64 CallbackBase* GetCallback();
67 * @brief Retrieve the slot observer.
69 * @return A pointer to the slot observer.
71 SlotObserver* GetSlotObserver();
75 SlotConnection( const SlotConnection& ); ///< undefined copy constructor
76 SlotConnection& operator=( const SlotConnection& ); ///< undefined assignment operator
80 SlotObserver* mSlotObserver; ///< a pointer to the slot observer (not owned)
81 CallbackBase* mCallback; ///< callback, has ownership
85 * @brief SignalConnection is the connection information held by the signal.
87 * A signal can have zero to many connections, depending on how
88 * many slots are connected to this signal.
90 * A connection contains:
92 * - SignalObserver - interface provided by a slot owning object.
94 * It holds a pointer to the callback, but does not own it.
97 class SignalConnection
102 * @brief Constructor.
104 * @param[in] callback The callback which should be a C function.
106 SignalConnection( CallbackBase* callback );
109 * @brief Constructor.
111 * @param[in] signalObserver The signal observer.
112 * @param[in] callback The callback which should be a member function of the signalObserver.
114 SignalConnection( SignalObserver* signalObserver, CallbackBase* callback );
117 * @brief Non-virtual destructor, not intended as a base class.
122 * @brief Disconnect the signal from the slot.
124 * @param[in] slotObserver The signal disconnecting from the slot.
126 void Disconnect( SlotObserver* slotObserver );
129 * @brief Retrieve the callback.
131 * @return A pointer to the callback.
133 CallbackBase* GetCallback();
137 SignalConnection( const SignalConnection& ); ///< undefined copy constructor
138 SignalConnection& operator=( const SignalConnection& ); ///< undefined assignment operator
142 SignalObserver* mSignalObserver; ///< a pointer to the signal observer (not owned)
143 CallbackBase* mCallback; ///< The callback. This is not owned, the corresponding SlotConnection has ownership.
148 #endif // __DALI_SIGNAL_SLOT_CONNECTIONS_H__