Add descriptions and example codes

[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 1a4267d..ca5c288 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,26 +1,27 @@
 #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) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */

 
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/buttons/button.h>
 
 
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/buttons/button.h>
 

-namespace Dali DALI_IMPORT_API
+namespace Dali

 {
 
 namespace Toolkit
 {
 
 namespace Toolkit


@@ -32,173 +33,122 @@ namespace Internal DALI_INTERNAL
 {
 class CheckBoxButton;
 }
 {
 class CheckBoxButton;
 }

+/**
+ * @addtogroup dali_toolkit_controls_buttons
+ * @{
+ */

 
 /**
 
 /**

- * CheckBoxButton provides a check box button which user can check or uncheck.
+ * @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.
+ *
+ * The button's appearance could be modified by Button::SetUnselectedImage, Button::SetBackgroundImage,
+ * Button::SetSelectedImage, Button::SetSelectedBackgroundImage, Button::SetDisabledBackgroundImage,
+ * Button::SetDisabledImage, and Button::SetDisabledSelectedImage.

  *
  *

- * By default a CheckBoxButton emits a Button::ClickedSignal() signal when the button changes its state to checked or unchecked.
+ * When the button is not disabled, if it's not selected it only shows the \e background image. The \e selected image is shown over the
+ * \e background image when the box is selected (\e background image is not replaced by \e selected image).

  *
  *

- * The button's appearance could be modified by setting images or actors with CheckBoxButton::SetBackgroundImage,
- * CheckBoxButton::SetCheckedImage, CheckBoxButton::SetDimmedBackgroundImage and CheckBoxButton::SetDimmedCheckedImage.
+ * When the button is disabled, \e background image and \e selected image are replaced by \e disabled images.

  *
  *

- * When the button is not dimmed, if it's not checked it only shows the \e background image. The \e checked image is shown over the
- * \e background image when the box is checked (\e background image is not replaced by \e checked image).
+ * Usage example: -

  *
  *

- * When the button is dimmed, \e background image and \e checked image are replaced by \e dimmed images.
+ * @code
+ * // in Creating a DALi Application
+ * void HelloWorldExample::Create( Application& application )
+ * {
+ *   CheckBoxButton button = CheckBoxButton::New();
+ *   button.SetParentOrigin( ParentOrigin::CENTER );
+ *   button.SetLabelText( "Check" );
+ *   button.SetSize( 200, 40 );
+ *   button.SetBackgroundColor( Color::WHITE );
+ *   Stage::GetCurrent().Add( button );

  *
  *

- * CheckBoxButton doesn't have a text. However, a Dali::Toolkit::TableView with a Dali::TextActor or a Dali::Toolkit::TextView
- * and a CheckBoxButton could be used instead.
+ *   // Connect to a button signal emitted by the button
+ *   button.StateChangedSignal().Connect( this, &HelloWorldExample::OnButtonStateChanged );
+ * }
+ *
+ * bool HelloWorldExample::OnButtonStateChanged( Button button )
+ * {
+ *   // Do something when the button state is changed
+ *   // You can get the state using button.IsSelected() call
+ *   return true;
+ * }
+ * @endcode
+ * @SINCE_1_0.0

  */
  */

-class CheckBoxButton : public Button
+class DALI_IMPORT_API CheckBoxButton : public Button

 {
 public:
 {
 public:

-  //Action Names
-  static const char* const ACTION_CHECK_BOX_BUTTON_CLICK;
-
-  // Properties
-  static const std::string USE_FADE_ANIMATION_PROPERTY_NAME;
-  static const std::string USE_CHECK_ANIMATION_PROPERTY_NAME;
-
-public:

 
   /**
 
   /**

-   * Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New()
+   * @brief Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New().

    * Calling member functions with an uninitialized Dali::Object is not allowed.
    * Calling member functions with an uninitialized Dali::Object is not allowed.

+   * @SINCE_1_0.0

    */
   CheckBoxButton();
 
   /**
    */
   CheckBoxButton();
 
   /**

-   * Copy constructor.
+   * @brief Copy constructor.
+   * @SINCE_1_0.0

    */
   CheckBoxButton( const CheckBoxButton& checkBox );
 
   /**
    */
   CheckBoxButton( const CheckBoxButton& checkBox );
 
   /**

-   * Assignment operator.
+   * @brief Assignment operator.
+   * @SINCE_1_0.0

    */
   CheckBoxButton& operator=( const CheckBoxButton& checkBox );
 
   /**
    */
   CheckBoxButton& operator=( const CheckBoxButton& checkBox );
 
   /**

-   * Virtual destructor.
-   * Dali::Object derived classes typically do not contain member data.
+   * @brief Destructor
+   *
+   * This is non-virtual since derived Handle types must not contain data or virtual methods.
+   * @SINCE_1_0.0

    */
    */

-  virtual ~CheckBoxButton();
+  ~CheckBoxButton();

 
   /**
 
   /**

-   * Create an initialized CheckBoxButton.
+   * @brief Create an initialized CheckBoxButton.
+   * @SINCE_1_0.0

    * @return A handle to a newly allocated Dali resource.
    */
   static CheckBoxButton New();
 
   /**
    * @return A handle to a newly allocated Dali resource.
    */
   static CheckBoxButton New();
 
   /**

-   * Downcast an Object handle to CheckBoxButton. If handle points to a CheckBoxButton the
+   * @brief Downcast a handle to CheckBoxButton handle.
+   *
+   * If handle points to a CheckBoxButton the

    * downcast produces valid handle. If not the returned handle is left uninitialized.
    * 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
    */
   static CheckBoxButton DownCast( BaseHandle handle );
 
    * @param[in] handle Handle to an object
    * @return handle to a CheckBoxButton or an uninitialized handle
    */
   static CheckBoxButton DownCast( BaseHandle handle );
 

-  /**
-   * Sets the button as checked or unchecked.
-   *
-   * Emits a Button::ClickedSignal() signal if the checkbox is not dimmed and the new state,
-   * given in the \e checked param, is different than the previous one.
-   *
-   * @param[in] checked state.
-   */
-  void SetChecked( bool checked );
-
-  /**
-   * @return \e true if the button is checked.
-   */
-  bool IsChecked() const;
-
-  /**
-   * Sets the background image.
-   *
-   * @param[in] image The background image.
-   */
-  void SetBackgroundImage( Image image );
-
-  /**
-   * @copydoc SetBackgroundImage( Image image )
-   */
-  void SetBackgroundImage( Actor image );
-
-  /**
-   * Gets the background image.
-   * @return An actor with the background image.
-   */
-  Actor GetBackgroundImage() const;
-
-  /**
-   * Sets the checked image.
-   *
-   * @param[in] image The checked image.
-   */
-  void SetCheckedImage( Image image );
-
-  /**
-   * @copydoc SetCheckedImage( Image image )
-   */
-  void SetCheckedImage( Actor image );
-
-  /**
-   * Gets the checked image.
-   * @return An actor with the checked image.
-   */
-  Actor GetCheckedImage() const;
-
-  /**
-   * Sets the dimmed background image.
-   *
-   * @param[in] image The dimmed background image.
-   */
-  void SetDimmedBackgroundImage( Image image );
-
-  /**
-   * @copydoc SetDimmedBackgroundImage( Image image )
-   */
-  void SetDimmedBackgroundImage( Actor image );
-
-  /**
-   * Gets the dimmed background image.
-   * @return An actor with the dimmed background image.
-   */
-  Actor GetDimmedBackgroundImage() const;
-
-  /**
-   * Sets the dimmed checked image.
-   *
-   * @param[in] image The dimmed checked image.
-   */
-  void SetDimmedCheckedImage( Image image );
-
-  /**
-   * @copydoc SetDimmedCheckedImage( Image image )
-   */
-  void SetDimmedCheckedImage( Actor image );
-
-  /**
-   * Gets the dimmed checked image.
-   * @return An actor with the dimmed checked image.
-   */
-  Actor GetDimmedCheckedImage() const;
-

 public: // Not intended for application developers
 
 public: // Not intended for application developers
 

+  /// @cond internal

   /**
   /**

-   * Creates a handle using the Toolkit::Internal implementation.
+   * @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.
    */

-  CheckBoxButton( Internal::CheckBoxButton& implementation );
+  DALI_INTERNAL CheckBoxButton( Internal::CheckBoxButton& implementation );

 
   /**
 
   /**

-   * Allows the creation of this Control from an Internal::CustomActor pointer.
+   * @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.
    */

-  CheckBoxButton( Dali::Internal::CustomActor* internal );
+  DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal );
+  /// @endcond

 };
 
 };
 

+/**
+ * @}
+ */

 } // namespace Toolkit
 
 } // namespace Dali
 } // namespace Toolkit
 
 } // namespace Dali