X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Factors%2Fcustom-actor.h;h=329840ed0f7497ba083ea0a5075ec12823fe3108;hb=0b501ba800a263b97d99adf224fc42d0c2aa8b37;hp=441b05273723687ca04381f185ef2c603542df15;hpb=199d46a42f943543a9d43cc3166a0d8b7cf63fd4;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/actors/custom-actor.h b/dali/public-api/actors/custom-actor.h index 441b052..329840e 100644 --- a/dali/public-api/actors/custom-actor.h +++ b/dali/public-api/actors/custom-actor.h @@ -1,8 +1,8 @@ -#ifndef __DALI_CUSTOM_ACTOR_H__ -#define __DALI_CUSTOM_ACTOR_H__ +#ifndef DALI_CUSTOM_ACTOR_H +#define DALI_CUSTOM_ACTOR_H /* - * Copyright (c) 2015 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. @@ -24,6 +24,10 @@ namespace Dali { +/** + * @addtogroup dali_core_actors + * @{ + */ namespace Internal DALI_INTERNAL { @@ -34,83 +38,111 @@ class CustomActor; * @brief CustomActor is a base class for custom UI controls. * * The implementation of the control must be supplied; see CustomActorImpl for more details. + * @SINCE_1_0.0 */ -class DALI_IMPORT_API CustomActor : public Actor +class DALI_CORE_API CustomActor : public Actor { public: - /** - * @brief Create an uninitialized CustomActor handle. + * @brief Creates an uninitialized CustomActor handle. * * Only derived versions can be instantiated. - * Calling member functions with an uninitialized Dali::Object is not allowed. + * Calling member functions with an uninitialized CustomActor handle is not allowed. + * @SINCE_1_0.0 */ CustomActor(); /** - * @brief Downcast an Object handle to CustomActor. + * @brief Downcasts a handle to CustomActor handle. * - * If handle points to a CustomActor the downcast produces valid - * handle. If not the returned handle is left uninitialized. + * If the handle points to a CustomActor, the downcast produces valid handle. + * If not, the returned handle is left uninitialized. * - * @param[in] handle to An object - * @return handle to a CustomActor or an uninitialized handle + * @SINCE_1_0.0 + * @param[in] handle Handle to an object + * @return Handle to a CustomActor or an uninitialized handle */ - static CustomActor DownCast( BaseHandle handle ); + static CustomActor DownCast(BaseHandle handle); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~CustomActor(); /** - * @brief Retrieve the custom actor implementation. + * @brief Retrieves the custom actor implementation. * - * @return The implementation. + * @SINCE_1_0.0 + * @return The implementation */ CustomActorImpl& GetImplementation(); /** - * @brief Retrieve the custom actor implementation. + * @brief Retrieves the custom actor implementation. * - * @return The implementation. + * @SINCE_1_0.0 + * @return The implementation */ const CustomActorImpl& GetImplementation() const; /** - * @brief Create an initialised CustomActor. + * @brief Creates an initialized CustomActor. * - * @param[in] implementation The implementation for this custom actor. - * @return A handle to a newly allocated Dali resource. + * @SINCE_1_0.0 + * @param[in] implementation The implementation for this custom actor */ CustomActor(CustomActorImpl& implementation); /** - * @brief Copy constructor + * @brief Copy constructor. * - * @param [in] copy The actor to copy. + * @SINCE_1_0.0 + * @param[in] copy The actor to copy */ CustomActor(const CustomActor& copy); /** - * @brief Assignment operator + * @brief Assignment operator. * - * @param [in] rhs The actor to copy. + * @SINCE_1_0.0 + * @param[in] rhs The actor to copy + * @return A reference to this */ CustomActor& operator=(const CustomActor& rhs); -public: // Not intended for application developers + /** + * @brief Move constructor. + * + * @SINCE_1_9.22 + * @param[in] rhs The actor to move + */ + CustomActor(CustomActor&& rhs) noexcept; /** + * @brief Move assignment operator. + * + * @SINCE_1_9.22 + * @param[in] rhs The actor to move + * @return A reference to this + */ + CustomActor& operator=(CustomActor&& rhs) noexcept; + +public: // Not intended for application developers + /** * @brief This constructor is used internally to create additional CustomActor handles. * - * @param [in] actor A pointer to a newly allocated Dali resource + * @SINCE_1_0.0 + * @param[in] actor A pointer to a newly allocated Dali resource */ CustomActor(Internal::CustomActor* actor); }; +/** + * @} + */ } // namespace Dali -#endif // __DALI_CUSTOM_ACTOR_H__ +#endif // DALI_CUSTOM_ACTOR_H