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

   1 #ifndef __DALI_SIGNAL_SLOT_OBSERVERS_H__
   2 #define __DALI_SIGNAL_SLOT_OBSERVERS_H__
   3
   4 /*
   5  * Copyright (c) 2015 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/common/dali-common.h>
  23
  24 namespace Dali
  25 {
  26 /**
  27  * @addtogroup dali-core-signals
  28  * @{
  29  */
  30
  31 class SlotObserver;
  32 class CallbackBase;
  33
  34 /**
  35  * @brief Abstract interface used by a signal to inform a slot it is disconnecting.
  36  *
  37  * This will happen if the object owning the signal is destroyed.
  38  */
  39 class DALI_IMPORT_API SignalObserver
  40 {
  41 public:
  42
  43   /**
  44    * @brief Constructor.
  45    */
  46   SignalObserver();
  47
  48   /**
  49    * @brief Virtual destructor.
  50    */
  51   virtual ~SignalObserver();
  52
  53   /**
  54    * @brief This method is called when the signal is disconnecting.
  55    *
  56    * @param[in] slotObserver The signal that has disconnected.
  57    * @param[in] callback The callback attached to the signal disconnected.
  58    */
  59   virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback ) = 0;
  60 };
  61
  62 /**
  63  * @brief Abstract Interface used by a slot to inform a signal it is disconnecting.
  64  *
  65  * This is used by the slot if wants to disconnect or is deleted.
  66  */
  67 class DALI_IMPORT_API SlotObserver
  68 {
  69 public:
  70
  71   /**
  72    * @brief Constructor.
  73    */
  74   SlotObserver();
  75
  76   /**
  77    * @brief Virtual destructor.
  78    */
  79   virtual ~SlotObserver();
  80
  81   /**
  82    * @brief This method is called when the slot is disconnecting.
  83    *
  84    * @param[in] callback The callback attached to the signal disconnected.
  85    */
  86   virtual void SlotDisconnected( CallbackBase* callback ) = 0;
  87 };
  88
  89 /**
  90  * @}
  91  */
  92 } // namespace Dali
  93
  94 #endif // __DALI_SIGNAL_SLOT_OBSERVERS_H__