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

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