#define __DALI_BASE_HANDLE_H__
/*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2015 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.
#include <dali/public-api/object/ref-object.h>
#include <dali/public-api/signals/functor-delegate.h>
-namespace Dali DALI_IMPORT_API
+namespace Dali
{
+/**
+ * @addtogroup dali_core_object
+ * @{
+ */
class BaseObject;
class ConnectionTrackerInterface;
+class TypeInfo;
/**
* @brief Dali::BaseHandle is a handle to an internal Dali resource.
* The internal Dali resources are reference counted. copying a Dali handle will increase the reference count.
* A resource will not be deleted until all its Dali::BaseHandle handles are destroyed, or reset.
*
+ * @SINCE_1_0.0
*/
-class BaseHandle
+class DALI_IMPORT_API BaseHandle
{
public:
/**
- * @brief Used for null pointer assignment below
- */
- class NullType
- {
- NullType() { }
- };
-
- /**
* @brief This constructor is used by Dali New() methods.
*
+ * @SINCE_1_0.0
* @param [in] handle A pointer to a newly allocated Dali resource
*/
BaseHandle(Dali::BaseObject* handle);
* handle = SomeClass::New(); // now initialized
* handle.SomeMethod(); // safe
* @endcode
+ * @SINCE_1_0.0
*/
BaseHandle();
* @brief Dali::BaseHandle is intended as a base class
*
* This is non-virtual since derived BaseHandle types must not contain data.
+ * @SINCE_1_0.0
*/
~BaseHandle();
/**
* @brief This copy constructor is required for (smart) pointer semantics.
*
+ * @SINCE_1_0.0
* @param [in] handle A reference to the copied handle
*/
BaseHandle(const BaseHandle& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* It makes this handle use the same BaseObject as the copied handle
+ * @SINCE_1_0.0
* @param [in] rhs A reference to the copied handle
* @return A reference to this handle
*/
BaseHandle& operator=(const BaseHandle& rhs);
/**
- * @brief This method is defined to allow assignment of the NULL value,
- * and will throw an exception if passed any other value.
- *
- * Assigning to NULL is an alias for Reset().
- * @param [in] rhs A NULL pointer
- * @return A reference to this handle
- */
- BaseHandle& operator=(NullType* rhs);
-
- /**
* @brief Connects a void() functor to a specified signal.
*
- * @pre The signal must be available in this object.
+ * @SINCE_1_0.0
* @param [in] connectionTracker A connection tracker which can be used to disconnect.
* @param [in] signalName Name of the signal to connect to.
* @param [in] functor The functor to copy.
* @return True if the signal was available.
+ * @pre The signal must be available in this object.
*/
template <class T>
bool ConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, const T& functor )
/**
* @brief Perform action on this object with the given action name and attributes.
*
+ * Usage example: -
+ * @code
+ * BaseHandle handle = SomeClass::New(); // Initialized with New() method
+ *
+ * Property::Map attributes; // Use empty Property::Map because "show" action doesn't need parameter
+ * handle.DoAction("show", attributes);
+ * @endcode
+ * @SINCE_1_0.0
* @param [in] actionName The command for the action.
* @param [in] attributes The list of attributes for the action.
* @return The action is performed by the object or not.
*/
- bool DoAction(const std::string& actionName, const std::vector<Property::Value>& attributes);
+ bool DoAction(const std::string& actionName, const Property::Map& attributes);
/**
* @brief Returns the type name for the Handle.
* Will return an empty string if the typename does not exist. This will happen for types that
* have not registered with type-registry.
*
+ * @SINCE_1_0.0
* @return The type name. Empty string if the typename does not exist.
*/
const std::string& GetTypeName() const;
+ /**
+ * @brief Returns the type info for the Handle.
+ *
+ * @SINCE_1_0.0
+ * @param[in] info The type information
+ * @return The type info
+ */
+ bool GetTypeInfo(Dali::TypeInfo& info) const;
+
public:
// BaseHandle accessors
* @brief Retrieve the internal Dali resource.
*
* This is useful for checking the reference count of the internal resource.
- * This method will assert, if the Dali::BaseHandle has not been initialized.
+ * This method will not check the validity of the handle so the caller is expected to check it by using if (handle)
+ * @SINCE_1_0.0
* @return The BaseObject which is referenced by the BaseHandle.
*/
BaseObject& GetBaseObject();
* @brief Retrieve the internal Dali resource.
*
* This is useful for checking the reference count of the internal resource.
- * This method will assert, if the Dali::BaseHandle has not been initialized.
+ * This method will not check the validity of the handle so the caller is expected to check it by using if (handle)
+ * @SINCE_1_0.0
* @return The BaseObject which is referenced by the BaseHandle.
*/
const BaseObject& GetBaseObject() const;
*
* If no other handle copies exist, the internal Dali resouce will be deleted.
* Calling this is not required i.e. it will happen automatically when a Dali::BaseHandle is destroyed.
+ * @SINCE_1_0.0
*/
void Reset();
* @brief Converts an handle to a BooleanType.
*
* This is useful for checking whether the handle is empty.
+ * @SINCE_1_0.0
*/
operator BooleanType() const;
/**
* @brief Equality operator overload.
*
+ * @SINCE_1_0.0
* @param [in] rhs A reference to the compared handle.
* @return true if the handle handles point to the same Dali resource, or if both are NULL.
*/
/**
* @brief Inequality operator overload.
*
+ * @SINCE_1_0.0
* @param [in] rhs A reference to the compared handle.
* @return true if the handle handles point to the different Dali resources.
*/
/**
* @brief Get the reference counted object pointer.
*
+ * @SINCE_1_0.0
* @return A pointer to the reference counted object.
*/
Dali::RefObject* GetObjectPtr() const;
/**
* @brief Not intended for application developers.
*
+ * @SINCE_1_0.0
* @param [in] connectionTracker A connection tracker which can be used to disconnect.
* @param [in] signalName Name of the signal to connect to.
* @param [in] functorDelegate A newly allocatated functor delegate (takes ownership).
*/
bool DoConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functorDelegate );
+protected:
+
/**
* @brief Used by the safe bool idiom.
*
+ * The safe bool idiom basically provides a Boolean test for classes. It validates objects
+ * in a boolean context without the usual harmful side effects.
+ * @SINCE_1_0.0
*/
void ThisIsSaferThanReturningVoidStar() const {}
private:
IntrusivePtr<Dali::RefObject> mObjectHandle; ///< Object this handle points at.
+
};
/**
- * @brief Template wrapper to downcast an base object handle to derived class handle.
+ * @brief Template wrapper to downcast a base object handle to derived class handle.
*
- * @pre The BaseHandle has been initialized.
- * @param handle to a base object
+ * @SINCE_1_0.0
+ * @param[in] handle to a base object
* @return handle pointer to either a valid deriving handle or an uninitialized handle
+ * @pre The BaseHandle has been initialized.
*/
template< class T >
-T DownCast( BaseHandle handle )
+inline T DownCast( BaseHandle handle )
{
return T::DownCast( handle );
}
/**
* @brief Equality operator
+ * @SINCE_1_0.0
+ * @param[in] lhs A reference to compare
+ * @param[in] rhs A reference to compare to
+ * @return true if the handle handles point to the same Dali resource, or if both are NULL
*/
template <typename T>
-bool operator==(const BaseHandle& lhs, const T& rhs)
+inline bool operator==(const BaseHandle& lhs, const T& rhs)
{
// We depart from the safe bool idiom to allow Dali::BaseHandle derived classes to be compared
return lhs == static_cast<const BaseHandle&>(rhs);
/**
* @brief Equality operator
+ * @SINCE_1_0.0
+ * @param[in] lhs A reference to compare
+ * @param[in] rhs A reference to compare to
+ * @return true if the handle handles point to the different Dali resources
*/
template <typename T>
-bool operator!=(const BaseHandle& lhs, const T& rhs)
+inline bool operator!=(const BaseHandle& lhs, const T& rhs)
{
// We depart from the safe bool idiom to allow Dali::BaseHandle derived classes to be compared
return lhs != static_cast<const BaseHandle&>(rhs);
}
-// More Operators
-
/**
* @brief Less than operator
+ * @SINCE_1_0.0
+ * @param[in] lhs A reference to compare
+ * @param[in] rhs A reference to compare to
+ * @return true if lhs less than rhs
*/
-bool operator<(const BaseHandle& lhs, const BaseHandle& rhs);
+inline bool operator<(const BaseHandle& lhs, const BaseHandle& rhs)
+{
+ return lhs.GetObjectPtr() < rhs.GetObjectPtr();
+}
+/**
+ * @}
+ */
} // namespace Dali
#endif // __DALI_BASE_HANDLE_H__
projects / platform / core / uifw / dali-core.git / blobdiff