1 #ifndef __DALI_TYPE_INFO_H__
2 #define __DALI_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.
23 #include <dali/public-api/object/base-handle.h>
24 #include <dali/public-api/common/vector-wrapper.h>
29 class ConnectionTrackerInterface;
30 class FunctorDelegate;
32 namespace Internal DALI_INTERNAL
38 * @brief TypeInfo class for instantiation of registered types and introspection of
39 * their actions and signals.
41 * See TypeRegistry for methods of type registration and TypeInfo retrieval.
43 class DALI_IMPORT_API TypeInfo : public BaseHandle
46 typedef BaseHandle (*CreateFunction)(); ///< Function signature for creating an instance of the associated object type.
48 typedef bool (*ActionFunction)(BaseObject*, const std::string&, const Property::Map&); ///< Function signature for creating scriptable actions
51 * @brief Connects a callback function with the object's signals.
53 * @param[in] object The object providing the signal.
54 * @param[in] tracker Used to disconnect the signal.
55 * @param[in] signalName The signal to connect to.
56 * @param[in] functor A newly allocated FunctorDelegate.
57 * @return True if the signal was connected.
58 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
60 typedef bool (*SignalConnectorFunction)(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
63 * @brief Callback to set an event-thread only property.
65 * @see PropertyRegistration.
66 * @param[in] object The object whose property should be set.
67 * @param[in] index The index of the property being set.
68 * @param[in] value The new value of the property for the object specified.
70 typedef void (*SetPropertyFunction)( BaseObject* object, Property::Index index, const Property::Value& value );
73 * @brief Callback to get the value of an event-thread only property.
75 * @see PropertyRegistration.
76 * @param[in] object The object whose property value is required.
77 * @param[in] index The index of the property required.
78 * @return The current value of the property for the object specified.
80 typedef Property::Value (*GetPropertyFunction)( BaseObject* object, Property::Index index );
83 * @brief Allows the creation of an empty TypeInfo handle.
90 * This is non-virtual since derived Handle types must not contain data or virtual methods.
95 * @brief This copy constructor is required for (smart) pointer semantics.
97 * @param [in] handle A reference to the copied handle
99 TypeInfo(const TypeInfo& handle);
102 * @brief This assignment operator is required for (smart) pointer semantics.
104 * @param [in] rhs A reference to the copied handle
105 * @return A reference to this
107 TypeInfo& operator=(const TypeInfo& rhs);
110 * @brief Retrieve the type name for this type.
112 * @return string name
114 const std::string& GetName() const;
117 * @brief Retrieve the base type name for this type.
119 * @return string of base name
121 const std::string& GetBaseName() const;
124 * @brief Create an object from this type.
126 * @return the BaseHandle for the newly created object
128 BaseHandle CreateInstance() const;
131 * @brief Retrieve the creator function for this type.
133 * @return the creator function
135 CreateFunction GetCreator() const;
138 * @brief Retrieve the number of actions for this type.
142 size_t GetActionCount() const;
145 * @brief Retrieve the action name for the index.
147 * @param[in] index Index to lookup
148 * @return action name or empty string where index is invalid
150 std::string GetActionName(size_t index);
153 * @brief Retrieve the number of signals for this type.
157 size_t GetSignalCount() const;
160 * @brief Retrieve the signal name for the index.
162 * @param[in] index Index to lookup
163 * @return signal name or empty string where index is invalid
165 std::string GetSignalName(size_t index);
168 * @brief Retrieve the number of propertys for this type.
172 size_t GetPropertyCount() const;
175 * @brief Retrieve the property name for the index.
177 * @param[in] index Index to lookup
178 * @return property name or empty string where index is invalid
180 std::string GetPropertyName(size_t index);
185 * @brief Retrieve all the property indices for this type.
187 * @param[out] indices Container of property indices
188 * @note The container will be cleared
190 void GetPropertyIndices( Property::IndexContainer& indices ) const;
193 * @brief Given a property index, retrieve the property name associated with it.
195 * @param[in] index The property index.
196 * @return The name of the property at the given index.
198 const std::string& GetPropertyName( Property::Index index ) const;
200 public: // Not intended for application developers
203 * @brief This constructor is used by Dali Get() method.
205 * @param [in] typeInfo A pointer to a Dali resource
207 explicit DALI_INTERNAL TypeInfo(Internal::TypeInfo* typeInfo);
213 #endif // __DALI_TYPE_INFO_H__