1 #ifndef __DALI_INTERNAL_TYPE_INFO_H__
2 #define __DALI_INTERNAL_TYPE_INFO_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
25 #include <dali/public-api/object/base-handle.h>
26 #include <dali/public-api/object/base-object.h>
27 #include <dali/public-api/object/type-info.h>
36 * A TypeInfo class to support registered type creation, and introspection of available
37 * actions and signal connection.
38 * It also supports doing actions and connecting signal handlers. Note this is properly
39 * conducted through the BaseHandle interface which uses the TypeRegistry to walk
42 class TypeInfo : public BaseObject
47 * @param [name] the registered name
48 * @param [baseName] the base type registered name
49 * @param [creator] the creator function for this type
51 TypeInfo(const std::string &name, const std::string &baseName, Dali::TypeInfo::CreateFunction creator);
59 * @copydoc Dali::TypeInfo::GetName
61 const std::string& GetName() const;
64 * @copydoc Dali::TypeInfo::GetBaseName
66 const std::string& GetBaseName() const;
69 * @copydoc TypeInfo::CreateFunction
71 BaseHandle CreateInstance() const;
74 * @copydoc Dali::TypeInfo::GetCreator
76 Dali::TypeInfo::CreateFunction GetCreator() const;
79 * @copydoc Dali::TypeInfo::GetActions
81 void GetActions( Dali::TypeInfo::NameContainer& container ) const;
84 * @copydoc Dali::TypeInfo::GetSignals
86 void GetSignals( Dali::TypeInfo::NameContainer& container) const;
89 * @copydoc Dali::TypeInfo::GetProperties
91 void GetProperties( Dali::TypeInfo::NameContainer& container) const;
94 * Adds the property indices to the container specified.
95 * @param[in/out] indices The container where the property indices are added.
97 void GetPropertyIndices( Property::IndexContainer& indices ) const;
100 * @copydoc Dali::TypeInfo::GetPropertyName() const
102 const std::string& GetPropertyName( Property::Index index ) const;
105 * Add an action function
107 void AddActionFunction( const std::string &actionName, Dali::TypeInfo::ActionFunction function );
110 * Add a function for connecting a signal.
111 * @param[in] signalName The name of the signal.
112 * @param[in] function The function used for connecting to the signal.
114 void AddConnectorFunction( const std::string& signalName, Dali::TypeInfo::SignalConnectorFunction function );
117 * Adds an event-thread only property to the type.
118 * @param[in] name The name of the property.
119 * @param[in] index The index of the property.
120 * @param[in] type The Property::Type.
121 * @param[in] setFunc The function to call to set the property (Can be NULL).
122 * @param[in] getFunc The function to call to retrieve the value of the property.
124 void AddProperty( const std::string& name, Property::Index index, Property::Type type, Dali::TypeInfo::SetPropertyFunction setFunc, Dali::TypeInfo::GetPropertyFunction getFunc );
127 * Adds an animatable property to the type.
128 * @param[in] name The name of the property.
129 * @param[in] index The index of the property
130 * @param[in] type The Property::Type.
132 void AddAnimatableProperty( const std::string& name, Property::Index index, Property::Type type );
135 * Adds a component of an animatable property to the type.
136 * The animatable property must have been type-registered and must be a Vector2, Vector3 or Vector4 type.
137 * @param[in] name The name of the component.
138 * @param[in] index The index of the property
139 * @param[in] baseIndex The index of the base animatable property
140 * @param[in] component The index The index of the component.
142 void AddAnimatablePropertyComponent( const std::string& name, Property::Index index, Property::Index baseIndex, unsigned int componentIndex );
145 * Do an action on base object
146 * @param [in] object The base object to act upon
147 * @param [in] actionName The name of the desired action
148 * @param [in] properties The arguments of the action
149 * @return bool If the action could be executed
151 bool DoActionTo(BaseObject *object, const std::string &actionName, const std::vector<Property::Value> &properties);
154 * Connects a callback function with the object's signals.
155 * @param[in] object The object providing the signal.
156 * @param[in] tracker Used to disconnect the signal.
157 * @param[in] signalName The signal to connect to.
158 * @param[in] functor A newly allocated FunctorDelegate.
159 * @return True if the signal was connected.
160 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
162 bool ConnectSignal( BaseObject* object, ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functor );
165 * Retrieve the property count for this type.
166 * @return The total number of properties.
168 unsigned int GetPropertyCount() const;
171 * Given a property name, retrieve the index.
172 * @param[in] name The name of the property.
173 * @return The index associated with that name.
175 Property::Index GetPropertyIndex( const std::string& name ) const;
178 * Given a property index, retrieve the index of its base property.
179 * @param[in] index The index of the property.
180 * @return The index of the base property associated with the given property index.
182 Property::Index GetBasePropertyIndex( Property::Index index ) const;
185 * Given a property index, retrieve its component index.
186 * @param[in] index The index of the property.
187 * @return The component index associated with that property index.
189 int GetComponentIndex( Property::Index index ) const;
192 * Checks if there is a setter for the property. If there is then it is writable.
193 * @param[in] index The property index.
194 * @return True, if writable, false otherwise.
196 bool IsPropertyWritable( Property::Index index ) const;
199 * Retrieve the Property::Type of the property at the given index.
200 * @param[in] index The property index.
201 * @return The Property::Type at that index.
203 Property::Type GetPropertyType( Property::Index index ) const;
206 * Sets the value of a property at the index specified for the given object.
207 * @param[in] object The object whose property is to be set.
208 * @param[in] index The property index.
209 * @param[in] value The value to set.
211 void SetProperty( BaseObject *object, Property::Index index, const Property::Value& value ) const;
214 * Sets the value of a property with the name specified for the given object.
215 * @param[in] object The object whose property is to be set.
216 * @param[in] name The property name.
217 * @param[in] value The value to set.
219 void SetProperty( BaseObject *object, const std::string& name, const Property::Value& value ) const;
222 * Retrieves the value of a property at the index specified for the given object.
223 * @param[in] object The object whose property is to be queried.
224 * @param[in] index The property index.
225 * @return The current value of the property.
227 Property::Value GetProperty( const BaseObject *object, Property::Index index ) const;
230 * Retrieves the value of a property with the name specified for the given object.
231 * @param[in] object The object whose property is to be queried.
232 * @param[in] name The property name.
233 * @return The current value of the property.
235 Property::Value GetProperty( const BaseObject *object, const std::string& name ) const;
239 struct RegisteredProperty
242 : type( Property::NONE ),
246 basePropertyIndex(Property::INVALID_INDEX),
247 componentIndex(Property::INVALID_COMPONENT_INDEX)
251 RegisteredProperty( Property::Type propType, Dali::TypeInfo::SetPropertyFunction set, Dali::TypeInfo::GetPropertyFunction get, const std::string& propName, Property::Index basePropertyIndex, int componentIndex )
256 basePropertyIndex(basePropertyIndex),
257 componentIndex(componentIndex)
262 Dali::TypeInfo::SetPropertyFunction setFunc;
263 Dali::TypeInfo::GetPropertyFunction getFunc;
265 Property::Index basePropertyIndex;
269 typedef std::pair<std::string, Dali::TypeInfo::SignalConnectorFunction > ConnectionPair;
270 typedef std::pair<std::string, Dali::TypeInfo::ActionFunction > ActionPair;
271 typedef std::pair<Property::Index, RegisteredProperty> RegisteredPropertyPair;
273 typedef std::vector< ActionPair > ActionContainer;
274 typedef std::vector< ConnectionPair > ConnectorContainer;
275 typedef std::vector< RegisteredPropertyPair > RegisteredPropertyContainer;
277 std::string mTypeName;
278 std::string mBaseTypeName;
279 Dali::TypeInfo::CreateFunction mCreate;
280 ActionContainer mActions;
281 ConnectorContainer mSignalConnectors;
282 RegisteredPropertyContainer mRegisteredProperties;
285 } // namespace Internal
287 // Helpers for public-api forwarding methods
289 inline Internal::TypeInfo& GetImplementation(Dali::TypeInfo& typeInfo)
291 DALI_ASSERT_ALWAYS(typeInfo);
293 BaseObject& handle = typeInfo.GetBaseObject();
295 return static_cast<Internal::TypeInfo&>(handle);
298 inline const Internal::TypeInfo& GetImplementation(const Dali::TypeInfo& typeInfo)
300 DALI_ASSERT_ALWAYS(typeInfo);
302 const BaseObject& handle = typeInfo.GetBaseObject();
304 return static_cast<const Internal::TypeInfo&>(handle);