-#ifndef __DALI_TYPE_INFO_H__
-#define __DALI_TYPE_INFO_H__
+#ifndef DALI_TYPE_INFO_H
+#define DALI_TYPE_INFO_H
/*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*
*/
+// EXTERNAL INCLUDES
+#include <cstdint> // uint32_t
// INTERNAL INCLUDES
+#include <dali/public-api/common/vector-wrapper.h>
#include <dali/public-api/object/base-handle.h>
-namespace Dali DALI_IMPORT_API
+namespace Dali
{
+/**
+ * @addtogroup dali_core_object
+ * @{
+ */
class ConnectionTrackerInterface;
class FunctorDelegate;
namespace Internal DALI_INTERNAL
{
- class TypeInfo;
+class TypeInfo;
};
/**
* their actions and signals.
*
* See TypeRegistry for methods of type registration and TypeInfo retrieval.
+ * @SINCE_1_0.0
*/
-class TypeInfo : public BaseHandle
+class DALI_CORE_API TypeInfo : public BaseHandle
{
public:
- typedef BaseHandle (*CreateFunction)(); ///< Function signature for creating an instance of the associated object type.
+ using CreateFunction = BaseHandle (*)(); ///< Function signature for creating an instance of the associated object type. @SINCE_1_0.0
- typedef bool (*ActionFunction)(BaseObject*, const std::string&, const std::vector<Property::Value>&); ///< Function signature for creating scriptable actions
+ using ActionFunction = bool (*)(BaseObject*, const std::string&, const Property::Map&); ///< Function signature for creating scriptable actions @SINCE_1_0.0
/**
* @brief Connects a callback function with the object's signals.
*
- * @param[in] object The object providing the signal.
- * @param[in] tracker Used to disconnect the signal.
- * @param[in] signalName The signal to connect to.
- * @param[in] functor A newly allocated FunctorDelegate.
- * @return True if the signal was connected.
+ * @SINCE_1_0.0
+ * @param[in] object The object providing the signal
+ * @param[in] tracker Used to disconnect the signal
+ * @param[in] signalName The signal to connect to
+ * @param[in] functor A newly allocated FunctorDelegate
+ * @return True if the signal was connected
* @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
*/
- typedef bool (*SignalConnectorFunctionV2)(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
+ using SignalConnectorFunction = bool (*)(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
/**
* @brief Callback to set an event-thread only property.
*
+ * @SINCE_1_0.0
+ * @param[in] object The object whose property should be set
+ * @param[in] index The index of the property being set
+ * @param[in] value The new value of the property for the object specified
* @see PropertyRegistration.
- * @param[in] object The object whose property should be set.
- * @param[in] index The index of the property being set.
- * @param[in] value The new value of the property for the object specified.
*/
- typedef void (*SetPropertyFunction)( BaseObject* object, Property::Index index, const Property::Value& value );
+ using SetPropertyFunction = void (*)(BaseObject* object, Property::Index index, const Property::Value& value);
/**
* @brief Callback to get the value of an event-thread only property.
*
+ * @SINCE_1_0.0
+ * @param[in] object The object whose property value is required
+ * @param[in] index The index of the property required
+ * @return The current value of the property for the object specified
* @see PropertyRegistration.
- * @param[in] object The object whose property value is required.
- * @param[in] index The index of the property required.
- * @return The current value of the property for the object specified.
*/
- typedef Property::Value (*GetPropertyFunction)( BaseObject* object, Property::Index index );
-
- typedef std::vector<std::string> NameContainer; ///< Container of names for signals and actions
+ using GetPropertyFunction = Property::Value (*)(BaseObject* object, Property::Index index);
/**
* @brief Allows the creation of an empty TypeInfo handle.
+ * @SINCE_1_0.0
*/
TypeInfo();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~TypeInfo();
/**
* @brief This copy constructor is required for (smart) pointer semantics.
*
- * @param [in] handle A reference to the copied handle
+ * @SINCE_1_0.0
+ * @param[in] handle A reference to the copied handle
*/
TypeInfo(const TypeInfo& handle);
/**
* @brief This assignment operator is required for (smart) pointer semantics.
*
- * @param [in] rhs A reference to the copied handle
+ * @SINCE_1_0.0
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
TypeInfo& operator=(const TypeInfo& rhs);
/**
- * @brief This method is defined to allow assignment of the NULL value,
- * and will throw an exception if passed any other value.
+ * @brief Move constructor.
*
- * Assigning to NULL is an alias for Reset().
- * @param [in] rhs A NULL pointer
+ * @SINCE_1_9.22
+ * @param[in] rhs A reference to the moved handle
+ */
+ TypeInfo(TypeInfo&& rhs);
+
+ /**
+ * @brief Move assignment operator.
+ *
+ * @SINCE_1_9.22
+ * @param[in] rhs A reference to the moved handle
* @return A reference to this handle
*/
- TypeInfo& operator=(BaseHandle::NullType* rhs);
+ TypeInfo& operator=(TypeInfo&& rhs);
+
+ /**
+ * @brief Retrieves the type name for this type.
+ *
+ * @SINCE_1_0.0
+ * @return String name
+ */
+ const std::string& GetName() const;
/**
- * @brief Retrieve the type name for this type.
+ * @brief Retrieves the base type name for this type.
*
- * @return string name
+ * @SINCE_1_0.0
+ * @return String of base name
*/
- const std::string& GetName();
+ const std::string& GetBaseName() const;
/**
- * @brief Retrieve the base type name for this type.
+ * @brief Creates an object from this type.
*
- * @return string of base name
+ * @SINCE_1_0.0
+ * @return The BaseHandle for the newly created object
*/
- const std::string& GetBaseName();
+ BaseHandle CreateInstance() const;
/**
- * @brief Create an object from this type.
+ * @brief Retrieves the creator function for this type.
*
- * @return the BaseHandle for the newly created object
+ * @SINCE_1_0.0
+ * @return The creator function
*/
- BaseHandle CreateInstance();
+ CreateFunction GetCreator() const;
/**
- * @brief Retrieve the creator function for this type.
+ * @brief Retrieves the number of actions for this type.
*
- * @return the creator function
+ * @SINCE_1_0.0
+ * @return The count
*/
- CreateFunction GetCreator();
+ size_t GetActionCount() const;
/**
- * @brief Retrieve the actions for this type.
+ * @brief Retrieves the action name for the index.
*
- * @return Container of action names
+ * @SINCE_1_0.0
+ * @param[in] index Index to lookup
+ * @return Action name or empty string where index is invalid
*/
- NameContainer GetActions();
+ std::string GetActionName(size_t index);
/**
- * @brief Retrieve the signals for this type.
+ * @brief Retrieves the number of signals for this type.
*
- * @return Container of signal names
+ * @SINCE_1_0.0
+ * @return The count
*/
- NameContainer GetSignals();
+ size_t GetSignalCount() const;
+
+ /**
+ * @brief Retrieves the signal name for the index.
+ *
+ * @SINCE_1_0.0
+ * @param[in] index Index to lookup
+ * @return Signal name or empty string where index is invalid
+ */
+ std::string GetSignalName(size_t index);
+
+ /**
+ * @brief Retrieves the number of event side type registered properties for this type.
+ *
+ * @SINCE_1_0.0
+ * @return The count
+ */
+ size_t GetPropertyCount() const;
// Properties
/**
- * @brief Retrieve all the property indices for this type.
+ * @brief Retrieves all the property indices for this type.
*
+ * @SINCE_1_0.0
* @param[out] indices Container of property indices
* @note The container will be cleared
*/
- void GetPropertyIndices( Property::IndexContainer& indices ) const;
+ void GetPropertyIndices(Property::IndexContainer& indices) const;
+
+ /**
+ * @brief Retrieves all the child property indices for this type.
+ *
+ * @SINCE_1_3.20
+ * @param[out] indices Container of property indices
+ * @note The container will be cleared
+ */
+ void GetChildPropertyIndices(Property::IndexContainer& indices) const;
/**
* @brief Given a property index, retrieve the property name associated with it.
*
- * @param[in] index The property index.
- * @return The name of the property at the given index.
+ * @SINCE_1_0.0
+ * @param[in] index The property index
+ * @return The name of the property at the given index
+ * @exception DaliException If index is not valid.
+ * @note this method only works for custom registered properties
*/
- const std::string& GetPropertyName( Property::Index index ) const;
+ std::string_view GetPropertyName(Property::Index index) const;
-public: // Not intended for application developers
+ /**
+ * @brief Given a child property name, retrieve the property index associated with it,
+ *
+ * @SINCE_1_3.20
+ * @param[in] name The name of the property at the given index,
+ * @return The property index or Property::INVALID_INDEX
+ */
+ Property::Index GetChildPropertyIndex(const std::string& name) const;
+
+ /**
+ * @brief Given a child property index, retrieve the property name associated with it.
+ *
+ * @SINCE_1_3.20
+ * @param[in] index The property index
+ * @return The name of the property at the given index, or empty string if it does not exist
+ */
+ std::string_view GetChildPropertyName(Property::Index index) const;
+
+ /**
+ * @brief Given a child property index, retrieve the property name associated with it.
+ *
+ * @SINCE_1_3.20
+ * @param[in] index The property index
+ * @return The name of the property at the given index, or empty string if it does not exist
+ */
+ Property::Type GetChildPropertyType(Property::Index index) const;
+public: // Not intended for application developers
+ /// @cond internal
/**
* @brief This constructor is used by Dali Get() method.
*
- * @param [in] typeInfo A pointer to a Dali resource
+ * @SINCE_1_0.0
+ * @param[in] typeInfo A pointer to a Dali resource
*/
explicit DALI_INTERNAL TypeInfo(Internal::TypeInfo* typeInfo);
-
+ /// @endcond
};
+/**
+ * @}
+ */
} // namespace Dali
-#endif // __DALI_TYPE_INFO_H__
+#endif // DALI_TYPE_INFO_H
projects / platform / core / uifw / dali-core.git / blobdiff