dali/internal/event/common/base-object-impl.h

   1 #ifndef DALI_BASE_OBJECT_IMPL_H
   2 #define DALI_BASE_OBJECT_IMPL_H
   3
   4 /*
   5  * Copyright (c) 2024 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/base-object.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/integration-api/ordered-set.h>
  26
  27 namespace Dali
  28 {
  29 /**
  30  * @brief Holds the Implementation for the BaseObject class
  31  */
  32 class BaseObject::Impl
  33 {
  34 public:
  35   /**
  36    * @brief Retrieves the implementation of the internal BaseObject class.
  37    * @param[in] internalBaseObject A ref to the BaseObject whose internal implementation is required
  38    * @return The internal implementation
  39    */
  40   static BaseObject::Impl& Get(BaseObject& baseObject);
  41
  42   /**
  43    * @copydoc Get( BaseObject& )
  44    */
  45   static const BaseObject::Impl& Get(const BaseObject& baseObject);
  46
  47   /**
  48    * @brief Constructor.
  49    * @param[in] baseObject The base object which owns this implementation
  50    */
  51   Impl(BaseObject& baseObject);
  52
  53   /**
  54    * @brief Destructor.
  55    */
  56   ~Impl();
  57
  58   class Observer
  59   {
  60   public:
  61     /**
  62      * Called shortly before the object itself is destroyed; no further callbacks will be received.
  63      * @param[in] object The base object.
  64      */
  65     virtual void ObjectDestroyed(BaseObject& object) = 0;
  66
  67   protected:
  68     /**
  69      * Virtual destructor
  70      */
  71     virtual ~Observer() = default;
  72   };
  73
  74   /**
  75    * Add an observer to the object.
  76    * @param[in] observer The observer to add.
  77    */
  78   void AddObserver(Observer& observer);
  79
  80   /**
  81    * Remove an observer from the object
  82    * @pre The observer has already been added.
  83    * @param[in] observer The observer to remove.
  84    */
  85   void RemoveObserver(Observer& observer);
  86
  87 private:
  88   BaseObject&                                    mBaseObject;
  89   Dali::Integration::OrderedSet<Observer, false> mObservers; ///< All observing items (not owned).
  90
  91   bool mObserverNotifying : 1; ///< Whether we are currently notifying observers.
  92 };
  93
  94 } // namespace Dali
  95
  96 #endif // DALI_BASE_OBJECT_IMPL_H