dali/public-api/signals/signal-slot-connections.h

   1 #ifndef __DALI_SIGNAL_SLOT_CONNECTIONS_H__
   2 #define __DALI_SIGNAL_SLOT_CONNECTIONS_H__
   3
   4 /*
   5  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/signals/signal-slot-observers.h>
  23
  24 namespace Dali
  25 {
  26 /**
  27  * @addtogroup dali_core_signals
  28  * @{
  29  */
  30
  31 class CallbackBase;
  32
  33 /**
  34  * @brief Slot connection is the connection information held by a connection tracker.
  35  *
  36  * A slot can have zero to many connection objects, depending
  37  * on how many signals it is connected to.
  38  *
  39  * A connection contains:
  40  * - Callback (slot)
  41  * - SlotObserver -interface provided by the signal
  42  *
  43  * It holds a pointer to the callback, but does not own it.
  44  * @SINCE_1_0.0
  45  */
  46 class DALI_CORE_API SlotConnection
  47 {
  48 public:
  49
  50   /**
  51    * @brief Constructor.
  52    *
  53    * @SINCE_1_0.0
  54    * @param[in] slotObserver The slot observer
  55    * @param[in] callback A callback object (not owned)
  56    */
  57   SlotConnection(SlotObserver* slotObserver, CallbackBase* callback);
  58
  59   /**
  60    * @brief Non-virtual destructor, not intended as a base class.
  61    * @SINCE_1_0.0
  62    */
  63   ~SlotConnection();
  64
  65   /**
  66    * @brief Retrieves the callback.
  67    *
  68    * @SINCE_1_0.0
  69    * @return A pointer to the callback
  70    */
  71   CallbackBase* GetCallback();
  72
  73   /**
  74    * @brief Retrieves the slot observer.
  75    *
  76    * @SINCE_1_0.0
  77    * @return A pointer to the slot observer
  78    */
  79   SlotObserver* GetSlotObserver();
  80
  81 private:
  82
  83   SlotConnection( const SlotConnection& );            ///< undefined copy constructor @SINCE_1_0.0
  84   SlotConnection& operator=( const SlotConnection& ); ///< undefined assignment operator @SINCE_1_0.0
  85
  86 private:
  87
  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.
  90 };
  91
  92 /**
  93  * @brief SignalConnection is the connection information held by the signal.
  94  *
  95  * A signal can have zero to many connections, depending on how
  96  * many slots are connected to this signal.
  97  *
  98  * A connection contains:
  99  * - Callback (slot)
 100  * - SignalObserver - interface provided by a slot owning object.
 101  *
 102  * It takes ownership of the callback, and will delete it when
 103  * the connection is destroyed.
 104  * @SINCE_1_0.0
 105  */
 106 class DALI_CORE_API SignalConnection
 107 {
 108 public:
 109
 110   /**
 111    * @brief Constructor.
 112    *
 113    * @SINCE_1_0.0
 114    * @param[in] callback The callback which should be a C function
 115    */
 116   SignalConnection( CallbackBase* callback );
 117
 118   /**
 119    * @brief Constructor.
 120    *
 121    * @SINCE_1_0.0
 122    * @param[in] signalObserver The signal observer
 123    * @param[in] callback Ownership of this callback object is taken
 124    */
 125   SignalConnection( SignalObserver* signalObserver, CallbackBase* callback );
 126
 127   /**
 128    * @brief Non-virtual destructor, not intended as a base class.
 129    * @SINCE_1_0.0
 130    */
 131   ~SignalConnection();
 132
 133   /**
 134    * @brief Disconnects the signal from the slot.
 135    *
 136    * @SINCE_1_0.0
 137    * @param[in] slotObserver The signal disconnecting from the slot
 138    */
 139   void Disconnect( SlotObserver* slotObserver );
 140
 141   /**
 142    * @brief Retrieves the callback.
 143    *
 144    * @SINCE_1_0.0
 145    * @return A pointer to the callback
 146    */
 147   CallbackBase* GetCallback();
 148
 149 private:
 150
 151   SignalConnection( const SignalConnection& );            ///< undefined copy constructor @SINCE_1_0.0
 152   SignalConnection& operator=( const SignalConnection& ); ///< undefined assignment operator @SINCE_1_0.0
 153
 154 private:
 155
 156   SignalObserver* mSignalObserver; ///< a pointer to the signal observer (not owned)
 157   CallbackBase* mCallback;         ///< The callback, has ownership.
 158 };
 159
 160 /**
 161  * @}
 162  */
 163 } // namespace Dali
 164
 165 #endif // __DALI_SIGNAL_SLOT_CONNECTIONS_H__