dali/public-api/object/base-object.h

   1 #ifndef __DALI_BASE_OBJECT_H__
   2 #define __DALI_BASE_OBJECT_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/object/ref-object.h>
  23 #include <dali/public-api/object/base-handle.h>
  24 #include <dali/public-api/object/property.h>
  25 #include <dali/public-api/signals/functor-delegate.h>
  26
  27 namespace Dali
  28 {
  29 /**
  30  * @addtogroup dali_core_object
  31  * @{
  32  */
  33
  34 class BaseHandle;
  35
  36 /**
  37  * @brief A base class for objects.
  38  */
  39 class DALI_IMPORT_API BaseObject : public Dali::RefObject
  40 {
  41 public:
  42
  43   /**
  44    * @brief Connects a void() functor to a specified signal.
  45    *
  46    * @pre The signal must be available in this object.
  47    * @param [in] connectionTracker A connection tracker which can be used to disconnect.
  48    * @param [in] signalName Name of the signal to connect to.
  49    * @param [in] functor The functor to copy.
  50    * @return True if the signal was available.
  51    */
  52   template <class T>
  53   bool ConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, const T& functor )
  54   {
  55     return DoConnectSignal( connectionTracker, signalName, FunctorDelegate::New( functor ) );
  56   }
  57
  58   /**
  59    * @copydoc Dali::BaseHandle::DoAction
  60    */
  61   bool DoAction(const std::string& actionName, const Property::Map& attributes);
  62
  63   /**
  64    * @copydoc Dali::BaseHandle::GetTypeName
  65    */
  66   const std::string& GetTypeName() const;
  67
  68   /**
  69    * @copydoc Dali::BaseHandle::GetTypeInfo
  70    */
  71   bool GetTypeInfo(Dali::TypeInfo& info) const;
  72
  73 public: // Not intended for application developers
  74
  75   /**
  76    * @copydoc Dali::BaseHandle::DoConnectSignal
  77    */
  78   bool DoConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functorDelegate );
  79
  80 protected:
  81
  82   /**
  83    * @brief Default constructor.
  84    */
  85   BaseObject();
  86
  87   /**
  88    * @brief A reference counted object may only be deleted by calling Unreference().
  89    */
  90   virtual ~BaseObject();
  91
  92   /**
  93    * @brief Registers the object as created with the Object registry.
  94    */
  95   void RegisterObject();
  96
  97   /**
  98    * @brief Unregisters the object from Object registry.
  99    */
 100   void UnregisterObject();
 101
 102 private:
 103
 104   // Not implemented
 105   DALI_INTERNAL BaseObject(const BaseObject& rhs);
 106
 107   // Not implemented
 108   DALI_INTERNAL BaseObject& operator=(const BaseObject& rhs);
 109 };
 110
 111 // Helpers for public-api forwarding methods
 112
 113 /**
 114  * @brief Get the implementation of a handle.
 115  *
 116  * @param[in] handle The handle
 117  * @return A reference to the object the handle points at.
 118  */
 119 inline BaseObject& GetImplementation(Dali::BaseHandle& handle)
 120 {
 121   DALI_ASSERT_ALWAYS( handle && "BaseObject handle is empty" );
 122
 123   return handle.GetBaseObject();
 124 }
 125
 126 /**
 127  * @brief Get the implementation of a handle.
 128  *
 129  * @param[in] handle The handle
 130  * @return A reference to the object the handle points at.
 131  */
 132 inline const BaseObject& GetImplementation(const Dali::BaseHandle& handle)
 133 {
 134   DALI_ASSERT_ALWAYS( handle && "BaseObject handle is empty" );
 135
 136   return handle.GetBaseObject();
 137 }
 138
 139 /**
 140  * @}
 141  */
 142 } // namespace Dali
 143
 144 # endif // __DALI_BASE_OBJECT_H__