[dali_1.9.23] Merge branch 'devel/master'

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / buttons / check-box-button.h

diff --git a/dali-toolkit/public-api/controls/buttons/check-box-button.h b/dali-toolkit/public-api/controls/buttons/check-box-button.h
index ca5c288..4ae4608 100644 (file)
--- a/dali-toolkit/public-api/controls/buttons/check-box-button.h
+++ b/dali-toolkit/public-api/controls/buttons/check-box-button.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_TOOLKIT_CHECK_BOX_BUTTON_H__
-#define __DALI_TOOLKIT_CHECK_BOX_BUTTON_H__
+#ifndef DALI_TOOLKIT_CHECK_BOX_BUTTON_H
+#define DALI_TOOLKIT_CHECK_BOX_BUTTON_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.
@@ -41,7 +41,7 @@ class CheckBoxButton;
 /**
  * @brief CheckBoxButton provides a check box button which user can check or uncheck.
  *
- * By default a CheckBoxButton emits a Button::ClickedSignal() signal when the button changes its state to selected or unselected.
+ * By default, a CheckBoxButton emits a Button::ClickedSignal() signal when the button changes its state to selected or unselected.
  *
  * The button's appearance could be modified by Button::SetUnselectedImage, Button::SetBackgroundImage,
  * Button::SetSelectedImage, Button::SetSelectedBackgroundImage, Button::SetDisabledBackgroundImage,
@@ -59,9 +59,9 @@ class CheckBoxButton;
  * void HelloWorldExample::Create( Application& application )
  * {
  *   CheckBoxButton button = CheckBoxButton::New();
- *   button.SetParentOrigin( ParentOrigin::CENTER );
- *   button.SetLabelText( "Check" );
- *   button.SetSize( 200, 40 );
+ *   button.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER );
+ *   button.SetProperty( Button::Property::LABEL, "Check" );
+ *   button.SetProperty( Actor::Property::SIZE, Vector2( 200, 40 );
  *   button.SetBackgroundColor( Color::WHITE );
  *   Stage::GetCurrent().Add( button );
  *
@@ -78,12 +78,12 @@ class CheckBoxButton;
  * @endcode
  * @SINCE_1_0.0
  */
-class DALI_IMPORT_API CheckBoxButton : public Button
+class DALI_TOOLKIT_API CheckBoxButton : public Button
 {
 public:
 
   /**
-   * @brief Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New().
+   * @brief Creates an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New().
    * Calling member functions with an uninitialized Dali::Object is not allowed.
    * @SINCE_1_0.0
    */
@@ -92,17 +92,37 @@ public:
   /**
    * @brief Copy constructor.
    * @SINCE_1_0.0
+   * @param[in] checkBox Handle to an object
    */
   CheckBoxButton( const CheckBoxButton& checkBox );
 
   /**
+   * @brief Move constructor
+   * @SINCE_1_9.23
+   *
+   * @param[in] rhs A reference to the moved handle
+   */
+  CheckBoxButton( CheckBoxButton&& rhs );
+
+  /**
    * @brief Assignment operator.
    * @SINCE_1_0.0
+   * @param[in] checkBox Handle to an object
+   * @return A reference to this
    */
   CheckBoxButton& operator=( const CheckBoxButton& checkBox );
 
   /**
-   * @brief Destructor
+   * @brief Move assignment
+   * @SINCE_1_9.23
+   *
+   * @param[in] rhs A reference to the moved handle
+   * @return A reference to this
+   */
+  CheckBoxButton& operator=( CheckBoxButton&& rhs );
+
+  /**
+   * @brief Destructor.
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
    * @SINCE_1_0.0
@@ -110,20 +130,20 @@ public:
   ~CheckBoxButton();
 
   /**
-   * @brief Create an initialized CheckBoxButton.
+   * @brief Creates an initialized CheckBoxButton.
    * @SINCE_1_0.0
-   * @return A handle to a newly allocated Dali resource.
+   * @return A handle to a newly allocated Dali resource
    */
   static CheckBoxButton New();
 
   /**
-   * @brief Downcast a handle to CheckBoxButton handle.
+   * @brief Downcasts a handle to CheckBoxButton handle.
    *
-   * If handle points to a CheckBoxButton the
-   * downcast produces valid handle. If not the returned handle is left uninitialized.
+   * If handle points to a CheckBoxButton, the downcast produces valid handle.
+   * If not, the returned handle is left uninitialized.
    * @SINCE_1_0.0
    * @param[in] handle Handle to an object
-   * @return handle to a CheckBoxButton or an uninitialized handle
+   * @return Handle to a CheckBoxButton or an uninitialized handle
    */
   static CheckBoxButton DownCast( BaseHandle handle );
 
@@ -133,14 +153,14 @@ public: // Not intended for application developers
   /**
    * @brief Creates a handle using the Toolkit::Internal implementation.
    * @SINCE_1_0.0
-   * @param[in]  implementation  The Control implementation.
+   * @param[in] implementation The Control implementation
    */
   DALI_INTERNAL CheckBoxButton( Internal::CheckBoxButton& implementation );
 
   /**
    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
    * @SINCE_1_0.0
-   * @param[in]  internal  A pointer to the internal CustomActor.
+   * @param[in] internal A pointer to the internal CustomActor
    */
   DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal );
   /// @endcond
@@ -153,4 +173,4 @@ public: // Not intended for application developers
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_CHECK_BOX_BUTTON_H__
+#endif // DALI_TOOLKIT_CHECK_BOX_BUTTON_H