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